Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "COSMOS Document Naming"

(Document naming)
Line 8: Line 8:
 
''Document coordinator''
 
''Document coordinator''
  
''Richard vasconi''
+
''Richard Vasconi''
 
''vasconi@us.ibm.com''
 
''vasconi@us.ibm.com''
  

Revision as of 16:05, 30 January 2008

COSMOS Wiki > COSMOS Document Plan

Document naming

Hi, I am open for suggestions in defining the best way to name our COSMOS documentation on our Wik pages. 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]]

Back to the top