User Tools

Site Tools


03_community:03_get_involved:02_add_content_to_wiki:00_guidlines

Guidelines

Please try to follow this Guidelines. :-)

  1. There are three types of pages:
    1. Start pages of namespaces
    2. Feature description
    3. Tutorials
  2. Each namespace has a start page with the same name
  3. Each start page follows the structure:
    1. Title
    2. Short summary
    3. List of the summary of all pages in the namespace
  4. Each feature description page follows the structure:
    1. Title
    2. Short summary
    3. Link to tutorials
    4. Description
    5. Further features (?)
  5. Each feature description page describes only one feature
  6. Each Tutorial page follows the structure:
    1. Title
    2. Short summary
    3. Link to explained features
    4. Expected knowledge + reference to where to find
    5. Required material
      1. link if from other tutorial
    6. Tutorials
    7. Final result (if existing)
    8. Further tutorials(?)
  7. Tutorials are combined with guides:
    1. Each guide has a start page:
      1. with a short description
      2. a list of the included tutorials (auto-generated by DocNavigation)
    2. Tutorials are linked as a new page with navigation and reference to the original page
  8. The depth of a subsection has to stay below 4
  9. Naming pages and subsections:
    1. begin with a two digit number (01_) to define the order on the menu and summaries
    2. no capital letters allowed
    3. words are separated by underscore
  10. Titles of pages start with headline level 1 (====== title======)
03_community/03_get_involved/02_add_content_to_wiki/00_guidlines.txt ยท Last modified: by Tim