Most recent edit on 2008-02-11 19:56:24 by BocdaRnosi [relacelacbod]
Additions:
eleloloerdar
Edited on 2008-01-03 15:21:28 by ElttrOcc4t [droneltc]
Additions:
boclibocara
Edited on 2007-12-31 22:55:31 by ChidoMmonc [ctrcnac4tlib]
Additions:
alnodelno
Edited on 2005-04-08 06:02:13 by GordonMcLean
Additions:
Writing Style
Note: Notes should be in italics, prefaced by "Note:", and not contain critical information.
Deletions:
Writing Style
Oldest known version of this page was edited on 2005-04-08 04:42:40 by GordonMcLean []
Page headings - always top of the page! - and only page headings should be in H2, like this:
Any internal page headings should be in H5 like this:
The introduction to procedures always start with "To..", have a blank line above and should be in bold. The procedures should be numbered lists and follow a complete route (readers can skip through the list if the step is not applicable to them), like this:
To make text bold do this:
Writing Style
Remember, you are writing for the lowest common denominator at all times. The writing should be first person active ("you") and not too informal. The writing style has to foster confidence in the information, this cannot be achieved with a chatty approach (which is more applicable in the forums).
Additions:
eleloloerdar
Edited on 2008-01-03 15:21:28 by ElttrOcc4t [droneltc]
Additions:
boclibocara
Edited on 2007-12-31 22:55:31 by ChidoMmonc [ctrcnac4tlib]
Additions:
alnodelno
Edited on 2005-04-08 06:02:13 by GordonMcLean
Additions:
Writing Style
Note: Notes should be in italics, prefaced by "Note:", and not contain critical information.
Deletions:
Writing Style
Oldest known version of this page was edited on 2005-04-08 04:42:40 by GordonMcLean []
Page view:
Style Guide
This page holds information about how to layout certain elements within a page. Ensuring any new pages are created in the same way lends more credence to the information (foster better confidence in the reader). Note that, by design, style sections are separated within this page, do not use the horizontal lines in this fashion on an actual page.Page headings - always top of the page! - and only page headings should be in H2, like this:
Page Heading
Any internal page headings should be in H5 like this:
Internal page section heading
The introduction to procedures always start with "To..", have a blank line above and should be in bold. The procedures should be numbered lists and follow a complete route (readers can skip through the list if the step is not applicable to them), like this:
To make text bold do this:
- Add two asterisks before the text
- Then add two after the text
- Everything between the asterisks will be bold. Simple.
Writing Style
Remember, you are writing for the lowest common denominator at all times. The writing should be first person active ("you") and not too informal. The writing style has to foster confidence in the information, this cannot be achieved with a chatty approach (which is more applicable in the forums).