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

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

The documentation for ~TiddlyWiki tries to follow a consistent editorial style. It has two main areas, each with its own tone and audience:

* [[Instruction Tiddlers]]
* [[Reference Tiddlers]]

Keep the two areas distinct, otherwise beginners will be overwhelmed and experts will be denied quick access to information.

* [[Tiddler Titles]]
* [[Tiddler Structure]]
* [[Spelling]]
* [[Typography]]
* [[Technical Prose Style]]
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`
Keep documentation style guide in the TOC 2014-12-30 18:38:22 +00:00			`tags: documenting [[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`

Initial expansion of the Documentation Style Guide 2014-12-26 19:24:47 +00:00			`The documentation for ~TiddlyWiki tries to follow a consistent editorial style. It has two main areas, each with its own tone and audience:`
First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00
Initial expansion of the Documentation Style Guide 2014-12-26 19:24:47 +00:00			`* [[Instruction Tiddlers]]`
			`* [[Reference Tiddlers]]`
Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00
Initial expansion of the Documentation Style Guide 2014-12-26 19:24:47 +00:00			`Keep the two areas distinct, otherwise beginners will be overwhelmed and experts will be denied quick access to information.`
Docs updates 2014-09-10 20:56:54 +00:00
Initial expansion of the Documentation Style Guide 2014-12-26 19:24:47 +00:00			`* [[Tiddler Titles]]`
			`* [[Tiddler Structure]]`
			`* [[Spelling]]`
			`* [[Typography]]`
			`* [[Technical Prose Style]]`