Question

I have installed projectdoc, but my existing documentation did not get any better! How long do I have to wait? Do I really have to use projectdoc templates and projectdoc macros by myself?

Answer

projectdoc is indeed no silver bullet to shoot at any wiki space and expect that a less-than-optimal documentation will magically turn into something more useful. projectdoc simply provides macros to define templates that make it easier to build sound and easy-to-use documentation. So a team deciding to employ projectdoc have to follow some conventions:

1. Define projectdoc documents by using
   
   1. Document Properties Marker Macro to define document properties
   2. Section Macro to define sections
2. Use projectdoc properties to describe your content
3. Use projectdoc to enhance navigability
   1. Provide Short Descriptions for your documents
   2. Use the Display Table Macro to automatically create lists of references upon query constraints
   3. Use the Tour Macro to define lists of references, transcluding information from the referenced documents
4. Employ modular documentation
   1. Define documents for information bits by using the Module Doctype
   2. Transclude content with the Transclusion Macro and the Transclude Documents Macro
   3. Transclude document properties with the Display Document Property Macro or one of its siblings
5. Use projectdoc to communicate the current development state of your documentation
   1. Define the current state using the Iteration Macro (this is included as the Iteration Property in most doctypes)
   2. Use box macros like Pending Box Macro or Feedback Box Macro to communicate with your team mates

It is recommended to make yourself familiar with projectdoc. Start with Installed it! What now? and check the resources of this web site.