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

created: 20140904164608166
modified: 20150117152546000
title: Documentation Style Guide
tags: [[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]]

We keep the two areas distinct. This avoids overwhelming relative newcomers, while still providing quick access to the information that expert users need.

Additional topics:

* [[Tiddler Title Policy]]
* [[Tiddler Structure]]
* [[Spelling]]
* [[Typography]]
* [[Documentation Macros]]
* [[Technical Prose Style]]
First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00			`created: 20140904164608166`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`modified: 20150117152546000`
First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00			`title: Documentation Style Guide`
Introduce documentation macros 2015-01-11 19:04:14 +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`

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
Introduce documentation macros 2015-01-11 19:04:14 +00:00			`We keep the two areas distinct. This avoids overwhelming relative newcomers, while still providing quick access to the information that expert users need.`
Docs updates 2014-09-10 20:56:54 +00:00
Introduce documentation macros 2015-01-11 19:04:14 +00:00			`Additional topics:`

			`* [[Tiddler Title Policy]]`
Initial expansion of the Documentation Style Guide 2014-12-26 19:24:47 +00:00			`* [[Tiddler Structure]]`
			`* [[Spelling]]`
			`* [[Typography]]`
Introduce documentation macros 2015-01-11 19:04:14 +00:00			`* [[Documentation Macros]]`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`* [[Technical Prose Style]]`