nivikcivik / pe Goto Github PK

Perhaps you may want to provide 2 code blocks with the 2 different command examples? It could be confusing to some users.

Perhaps inputs can be trimmed as I can input whitespaces in fields.

I think these are small rendering errors (assuming from "**" to point form) which could affect your DG's readability.

The diagram sizes are not uniform. Perhaps you may want to resize some of the larger diagrams for more consistency and readability?

I followed the specific format in the UG at first (editprofile), but my command was not recognised. A bit of inconsistency. Perhaps you can show the correct input example within the same code block and change the typos for less confusion.

I spotted a few typos for the product name.

1. In your "help" message:
   
2. In your DG Architecture Diagram:
   
3. In your DG Launch Testing Section:
   
4. In your DG Non-Functional Requirements Section:
   
5. In your DG Command Summary Section
   

Although weight is specified to be a number and the error is identified with a unique message, the license plate has a strict rule of no punctuation. Perhaps developers can create a custom error message for the license plate error as well? So that users can know what they did wrongly.

This sequence diagram (from Section: [Implementation] : List Assigned Deliveries) has some numberings. Perhaps they can be removed as they are not referred to by these numberings, and they probably do not follow the UML Standards.

FileWriter() (in DG Storage Component Section) is not referenced anywhere else. Perhaps they can be defined in the Glossary section? As a beginner to programming would not understand this completely.
e.g. FileWriter() can be described in the Glossary Section