mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-02-23 06:20:01 +00:00
Code Issues Releases Wiki Activity

First pass at a documentation style guide

Browse Source 
Needs more detail.
This commit is contained in:
Jermolene 2014-09-04 17:51:08 +01:00
parent aa6e317435
commit abe9a0dbc2
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
editions/tw5.com/tiddlers/Documentation Style Guide.tid Normal file
View File

@ -0,0 +1,10 @@
created: 20140904164608166
modified: 20140904164935351
title: Documentation Style Guide
type: text/vnd.tiddlywiki
The documentation for ~TiddlyWiki tries to follow the following guidelines. The aim is to ensure that documentation from different authors reads consistently.
# Do address the reader directly as "you"
# Avoid the [[passive voice|http://grammar.ccc.commnet.edu/grammar/passive.htm]] in tutorial and introductory material
# Do use [[British spellings in preference to US spellings|http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences]]

8
editions/tw5.com/tiddlers/howtos/Improving TiddlyWiki Documentation.tid
View File

@ -1,10 +1,12 @@
title: Improving TiddlyWiki Documentation
tags: howto
created: 20140820151051019
modified: 20140830151051019
modified: 20140904165057207
tags: howto
title: Improving TiddlyWiki Documentation
type: text/vnd.tiddlywiki
Anyone can submit improvements to the TiddlyWiki documentation that appears on http://tiddlywiki.com.
# Read and observe the [[Documentation Style Guide]]
# Create an account on https://github.com if you don't already have one
# On http://tiddlywiki.com, click "edit" on the tiddler you want to improve
# You should see a pink banner with the text: //Can you help us improve this documentation? Find out how to edit this tiddler on ~GitHub//