This topic is a stub; you can help Foswiki by expanding the content here to describe best practices for documentation.
Documentation standards for developers
For guidelines on writing, please see HowToWriteBetterCopy
For language usage guidelines, please refer to the language usage style guide
Guidelines for what to document
As in any other software project, it's important that careful attention is paid to documentation. This section describes standards for the mechanics of documentation: what should be documented, and how it fits into the existing documentation structure.
The following is not covered in this section:
- good technical authoring practice
- source code documentation — see the coding standards
Adding documentation topics
The documentation is designed to be appreciated as a single large reference manual (book). All the documentation topics are collated into a single large ReferenceManual
. If you create any new documentation topics, they must fit logically into this big book.
Adding documentation of new Variables
Adding documentation for Extensions
Documenting Plugin variables