From BlenderWiki

Jump to: navigation, search
Note: This is an archived version of the Blender Developer Wiki. The current and active wiki is available on wiki.blender.org.

Wiki Improvements

See my Formatting Mockup

Formatting

Here are my suggestions for improved formatting:

  • Literals: UI items should be bold, or bold+italic). Bold stands out better than italic alone
  • Links: brighter blue to help them stand out
  • Indent text/headings under ==heading 2== to better separate sections.
  • Increase size of ==heading 2== to make it more separate from ===heading 3===
  • Add a bar/background color to headings
  • Left align when possible

Consistency and Simplification

Recommendations for consistent formatting:

  • One =heading 1= per page, as recommended in the Mediawiki documentation
  • Describe UI items/options with a clear separation between the word and the description
    • Term on its own line, and the descriptions on next line, indented
    • Not bulleted. Visually interferes with the word itself, and is consistent with most of the manual and other manuals
  • Bullets are only for examples/lists of things
  • Numbered lists for explanation of steps
  • Tables are for larger lists with descriptions
  • Use logical heading nesting

Recommendations for simplification:

  • Omit unnecessary sub-headings, like ==Description==. (It should be assumed that what is written is a description).
  • Avoid being verbose. Be concise.
  • Don't include unnecessary images
  • Remove "mode" from ref boxes, unless necessary