mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-07-01 09:43:16 +00:00
19 lines
597 B
Plaintext
19 lines
597 B
Plaintext
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]]
|