Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Document Naming"
(→Document naming) |
(→Document naming) |
||
| Line 15: | Line 15: | ||
Where '''''{document}''''' is the type of document, for example: | Where '''''{document}''''' is the type of document, for example: | ||
| − | + | * Users_Guide | |
| − | + | * Reference_Guide | |
Where '''''{topic}''''' is the name of the COSMOS component or subject, for example: | Where '''''{topic}''''' is the name of the COSMOS component or subject, for example: | ||
| − | + | * SML | |
| − | + | * Data_Manager | |
| − | + | * WSDM_tooling | |
Revision as of 14:00, 28 January 2008
Document naming
Hi, I am open for suggestions in defining the best way to name our COSMOS documentation. The following is an example of what I came up with, but the filename is very long.
Document coordinator
Richard vasconi vasconi@us.ibm.com
When creating a Wiki document page, please use the following naming structure:
- wiki.eclipse.org/COSMOS_Document_{document}_{topic}
Where {document} is the type of document, for example:
- Users_Guide
- Reference_Guide
Where {topic} is the name of the COSMOS component or subject, for example:
- SML
- Data_Manager
- WSDM_tooling
Naming examples:
- COSMOS_Document_Users_Guide_WSDM_tooling
Adding a Category document reference
To help organize and locate documents, please insert the following category tag at the bottom of you document Wiki page:
[[Category:COSMOS Documents]]