clone/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/TiddlyWiki/TiddlyWiki5.git synced 2026-05-01 05:26:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Introduce documentation macros

Browse Source
This commit is contained in:
Astrid Elocson
2015-01-11 19:04:14 +00:00
parent d5278866fd
commit 76a3a44d4c
11 changed files with 322 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
editions/tw5.com/tiddlers/styleguide/Documentation Style Guide.tid
View File

@@ -1,7 +1,7 @@
created: 20140904164608166
modified: 20140904164935351
modified: 20150110181800000
title: Documentation Style Guide
tags: documenting [[Improving TiddlyWiki Documentation]]
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:
@@ -9,10 +9,13 @@ The documentation for ~TiddlyWiki tries to follow a consistent editorial style.
* [[Instruction Tiddlers]]
* [[Reference Tiddlers]]
Keep the two areas distinct, otherwise beginners will be overwhelmed and experts will be denied quick access to information.
We keep the two areas distinct. This avoids overwhelming relative newcomers, while still providing quick access to the information that expert users need.
* [[Tiddler Titles]]
Additional topics:
* [[Tiddler Title Policy]]
* [[Tiddler Structure]]
* [[Spelling]]
* [[Typography]]
* [[Technical Prose Style]]
* [[Documentation Macros]]
* [[Technical Prose Style]]