Changes between Version 9 and Version 10 of UNPLANNED_USER_DOC_STRUCTURE/StyleGuide


Ignore:
Timestamp:
12/18/08 17:13:56 (16 years ago)
Author:
danvisel
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • UNPLANNED_USER_DOC_STRUCTURE/StyleGuide

    v9 v10  
    1111 * Each release will have its own documentation directory in the wiki: e.g. for iteration 3, the user documentation is at [wiki:ITERATION_03/Release/UserDocumentation]. 
    1212 
    13  * Names for pages in the wiki will be in the form "xx_SectionTitle"; 'xx' is the number of the section in the outline. Subsections are subdirectories. Thus we have, for example, [wiki:ITERATION_03/Release/UserDocumentation/02_WorkingWithSophie/02_HalosAndHUDs], which is section 2.2, Halos and HUDs. Numbers follow the outline at [wiki:UNPLANNED_USER_DOC_STRUCTURE/Outline]. Names are in camelcase and should be the complete title of the section to avoid confusion. 
     13 * Names for pages in the wiki will be in the form ''xx_SectionTitle''; ''xx'' is the number of the section in the outline. Subsections are subdirectories. Thus we have, for example, [wiki:ITERATION_03/Release/UserDocumentation/02_WorkingWithSophie/02_HalosAndHUDs], which is section 2.2, "Halos and HUDs". Numbers follow the outline at [wiki:UNPLANNED_USER_DOC_STRUCTURE/Outline]. Names are in camelcase and should be the complete title of the section to avoid confusion. 
    1414 
    1515 * When Sophie Author/Sophie Reader/Sophie Server are separated into distinct sections, there will be distinct subdirectories for Author, Reader, and Server. So !Release/UserDocumentation/02_WorkingWithSophie/02_HalosAndHUDs will move to !Release/UserDocumentation/Author/02_WorkingWithSophie/02_HalosAndHUDs. 
    1616 
    17  * Each page begins with a ![[BackLinksMenu]] command and ends with a ![[TitleIndex(xxx)]] where 'xxx' is the page's path in the wiki. The title of the section is given as the header for the page, including the numbers of the outline, e.g. '''2.2. Halos and HUDs'''.  
     17 * Each page begins with a ![[BackLinksMenu]] command and ends with a ![[TitleIndex(xxx)]] where ''xxx'' is the page's path in the wiki. The title of the section is given as the header for the page, including the numbers of the outline, e.g. '''2.2. Halos and HUDs'''.  
    1818 
    1919 * Each page should have an outline of the subsections in it. For example, section 2 should include a bulleted list with 2.1, 2.2, 2.3, 2.4. For interim releases where functionality is not present (e.g. embedded books in the Iteration 3 release), a page should be added saying that that functionality is not part of this release; however, these pages should not be listed in the outlines.