From e415edb4405003413b40820c7c4556b33b278204 Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Fri, 26 Dec 2014 19:29:41 +0000 Subject: [PATCH] Create Tiddler Structure.tid --- .../tw5.com/tiddlers/about/Tiddler Structure.tid | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 editions/tw5.com/tiddlers/about/Tiddler Structure.tid diff --git a/editions/tw5.com/tiddlers/about/Tiddler Structure.tid b/editions/tw5.com/tiddlers/about/Tiddler Structure.tid new file mode 100644 index 000000000..26ef86882 --- /dev/null +++ b/editions/tw5.com/tiddlers/about/Tiddler Structure.tid @@ -0,0 +1,15 @@ +created: 20141226192500000 +title: Tiddler Structure +tags: documenting + +In accordance with the [[Philosophy of Tiddlers]], documentation tiddlers are typically short and interlinked. + +When a tiddler seems as if it needs to contain subheadings, this is often a sign that it should in fact be split into several tiddlers. But it is reasonable for a [[Reference Tiddler|Reference Tiddlers]] to consist of an untitled introductory section followed by a titled section of details. + +Consistency of terminology is essential if the reader is not to become confused. Consistent typography and punctuation lend a professional quality to the documentation. Macros can improve the consistency and maintainability of the text. + +Use numbered lists for step-by-step instructions, and bullet points for lists whose order is arbitrary. Use a definition list in preference to a bulleted list if each bulleted item would begin with a term and a colon. If at all possible, avoid burdening the reader with a nested list. + +Use a table when information naturally falls into three or more columns, and also for lists of parameters, attributes, etc in [[Reference Tiddlers]]. + +The documentation describes the current reality of ~TiddlyWiki. Avoid discussing future aspirations.