TiddlyWiki5/editions/tw5.com/tiddlers/about/Documentation Style Guide.tid

created: 20140904164608166
modified: 20140904164935351
title: Documentation Style Guide
tags: Improving TiddlyWiki Documentation
type: text/vnd.tiddlywiki

The documentation for ~TiddlyWiki tries to follow the following guidelines. The aim is to ensure that documentation from different authors reads consistently.

# Do address the reader directly as "you"
# Avoid the [[passive voice|http://grammar.ccc.commnet.edu/grammar/passive.htm]] in tutorial and introductory material
# Do use [[British spellings in preference to US spellings|http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences]]

See also the guidelines for [[tiddler titles|Adopt a Titles Policy]].
First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00			`created: 20140904164608166`
			`modified: 20140904164935351`
			`title: Documentation Style Guide`
More docs cleanup 2014-09-20 11:46:31 +00:00			`tags: Improving TiddlyWiki Documentation`
First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00			`type: text/vnd.tiddlywiki`

			`The documentation for ~TiddlyWiki tries to follow the following guidelines. The aim is to ensure that documentation from different authors reads consistently.`

			`# Do address the reader directly as "you"`
			`# Avoid the [[passive voice\|http://grammar.ccc.commnet.edu/grammar/passive.htm]] in tutorial and introductory material`
			`# Do use [[British spellings in preference to US spellings\|http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences]]`
Docs updates 2014-09-10 20:56:54 +00:00
			`See also the guidelines for [[tiddler titles\|Adopt a Titles Policy]].`