Documentation Types

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Documentation Types

Gary S
This post was updated on .
LibreCAD user documentation will consist of four types:
1. Reference Manual – The ‘Reference Manual’ is simply an explanation of each command (or tool) available in LibreCAD.  The reference manual provides a brief description of the command and what parameters are necessary.  It is the dry, boring information important to be able to gain an understanding of the purpose of each command.  There is no explanation of how to use any particular command or the circumstance that would require it.  Those explanations are documented in the next section.
e.g. Line -> Rectangle {DrawLineRectangle}: Draw a rectangle by assigning the points of two diagonally opposite corners. 
2. How to Guides – The ‘How to Guides’ are intended to provide a the steps necessary to perform a particular task.  These task are generic in the sense that they can be used in any type of drawing or circumstance.  They are the ‘building blocks’ of a drawing.
e.g. Printing Guide
3. Tutorials - ‘Tutorials’ provide step by step examples on how to create drawings for a specific purpose.  A tutorial doesn’t require a full understanding of the commands used, but provides sufficient detail to allow the user to complete the drawing.
e.g. Drawing a carport truss
4. Other types – Other types of documentation are to provide an understanding or background information.
e.g. Overview