Difference between revisions of "COSMOS Document Naming"

Revision as of 16:11, 5 February 2008

COSMOS Wiki > COSMOS Document Plan This section covers the naming of a COSMOS document and adding a Category documentation reference.

Document naming

When creating a Wiki document page, use the following naming structure:

• wiki.eclipse.org/COSMOS_Users's_Guide_{topic}
• or wiki.eclipse.org/COSMOS_Development_Guide_{topic}

Where {topic} is the name of the COSMOS component or subject, for example: The following items are a few topics of the COSMOS User's Guide.

• Overview
• Management Enablement
• WSDM_tooling

Naming examples:

• COSMOS_User's_Guide_Management_Enablement

Adding a Category documentation reference

To help organize and locate documents, please insert the following category tag at the bottom of your document Wiki page:

'''[[Category:COSMOS Consumer Documentation]]'''

Hierarchy of documentation categories example

[[Category:COSMOS]]
.... [[Category:COSMOS Consumer Documentation]]
............ [[Category:COSMOS User's Guide]]
............ [[Category:COSMOS Development Guide]]

[[Category:COSMOS User's Guide]]

[[Category:COSMOS Consumer Documentation]]

[[Category:COSMOS Consumer Documentation]]