Documenting Sailcut
From Sailcut
A considerable amount of effort goes into writing documentation for Sailcut CAD, the result of which is the Sailcut CAD Handbook.
About the Sailcut CAD Handbook
The Sailcut CAD Handbook is written in DocBook, an XML-based format which can easily be edited using a text editor. There are a number of good DocBook editors available, among which:
- Quanta Plus, a web development environment for the K Desktop Environment.
Documentation guidelines
The following rules must be observed when writing documentation for Sailcut CAD.
- DocBook is not a layout language, so do not attempt to force the layout with excessive use of tags such as <emphasis>.
- When referring to menus, menu submenus and menu entries, make use of the <guimenu>, <guisubmenu> and <guimenuitem> tags.
- When referring to a window or a box inside a window, use the <guilabel> tag.
- When referring to a button, use the <guibutton> tag.
