| Version 6 (modified by danvisel, 16 years ago) (diff) |
|---|
User Documentation Style Guide
This page is a sample style guide for creating user documentation. This is part of UNPLANNED_USER_DOC_STRUCTURE_R0..
Organization
- Each numbered item in the user documentation structure (UNPLANNED_USER_DOC_STRUCTURE/Outline) will get its own page in the wiki.
- Names for pages in the wiki will be in the form "Documentation_1_WorkingWithSophie" or "Documentation_1_1_SophiesInterface". The prefix "Documentation_" is followed by the page's place in the documentation outline (with underscores separating the numbers) which will be followed by the title of the section without spaces or punctuation but with camelcaps.
- When Sophie Author/Sophie Reader/Sophie Server are separated into distinct sections, the names of the pages will be in the form "!SophieAuthorDocumentation_1_WorkingWithSophie", with the prefixes being "!SophieAuthorDocumentation_", "!SophieReaderDocumentation_", and "!SophieServerDocumentation_".
Images
- Images go in subversion at trunk/sophie2-platform/doc/user_doc_images/ . Images are structured by release; UNPLANNED_USER_DOC_SAMPLE contains images for the documentation sample, RELEASE_3 contains images added for RELEASE_3. Each new release will get a new subdirectory.
- Images should not be more than 800 pixels wide.
Conventions
- Use "Sophie 2" rather than "Sophie2": we want to emphasize continuity from Sophie 1 to Sophie 2. "Sophie 2.0" is also acceptable.
- It is not necessary to always say "Sophie 2" or "Sophie 2.0"; simply "Sophie" is fine.
Extensibility
- More rules will be added to this list as they are needed and created.
