Developing documentation has issues. These issues are different, albeit comparable, to issues the developers will face.
This document poses questions and offers solutions to common scenarios.
1 file? Multiple files? Folders? Indexes?
How should the information be structured? By feature/doc-type or doc-type feature. Perhaps favor the writer over the reader, so feature/doc-type would be best.
A consistant way to name things.
The documentation should be in a consistent tense. Use the imperative, present tense: "change", not "changed" or "changes".
Collecting, categorizing, prioritizing, assigning, and viewing issues.
What features and fixes made it into what releases.
How much God has been documented?
Links create connections between sections and document and document types.
How to link to source code documentation? The javadoc directive will merge or link in the indicated package or class documentation.
<div class='ddd-container ddd-javadoc'><span class='ddd-type'>javadoc</span>: package com.foo.bar<div></div></div> <div class='ddd-container ddd-javadoc'><span class='ddd-type'>javadoc</span>: class com.foo.bar.TheClass<div></div></div>
<div class='ddd-container ddd-see'><span class='ddd-type'>see</span>: ... <div></div></div>Clone
<div class='ddd-container ddd-clone'><span class='ddd-type'>clone</span>: ...<div></div></div>### Template Common descriptions can be duplicated or linked to. Template Definitions
[tab press <tab> to move between fields]U-Doc
Save Document Form
[tab]## Collaborative Editing How to handle multple editors at the same time. How to merge changes.