slitaz-doc-wiki-data view pages/en/guidelines.txt @ rev 42
Updated pages folder.
| author | Christopher Rogers <slaxemulator@gmail.com> |
|---|---|
| date | Wed Apr 20 19:44:46 2011 +0000 (2011-04-20) |
| parents | |
| children | bbe140fda581 |
line source
1 ====== SliTaz Documentation Guidelines =====
2 This document provides guidelines on writing a wiki article and the tasks to be performed to make SliTaz documentation up-to-date.
4 //
5 //
7 ===== Summer of Documentation =====
8 - Centralization of all documentation to http://doc.slitaz.org
9 - Complete migration of Handbook and Cookbook (Scratchbook, if possible)
10 - Translation of Handbook and Cookbook
11 - Link or translate the wiki articles on the [[http://labs.slitaz.org|labs website]]
12 - Review and update Handbook and Cookbook as of 3.0
13 - Add new guides. A wishlist of guides has been predefined on the [[http://doc.slitaz.org/en:guides:start| guides page]] as a starting reference
14 - Review and update existing guides
16 //
17 //
19 ===== General Instructions =====
20 * **Add** : Feel free to add any pages to the wiki
21 * __Namespaces or Documentation Hierarchy__ : Documentation Hierarchy structure has been defined for the English language. Please follow it as a standard while creating pages. Some examples :
22 * //en:handbook:start// : Handbook start page
23 * //en:handbook:desktop// : Desktop is a page link on the handbook start page. All handbook pages should have the namespace "en:handbook:"
24 * //en:guides:faq// : All guides pages should have namespaces "en:guides". To create a faq page, simply do <nowiki> [[faq | FAQ]] </nowiki>. This will automatically create a faq page with the en:guides:faq namespace
25 * //Index// : Links can be used to see the hierarchy structure
26 * __Add Images__ : Use the toolbar and add images to the relevant namespaces
27 * **Delete** : Simply remove all the contents of the pages to delete a page
28 * **Review** : Each page should contain a review section. For example, [[http://doc.slitaz.org/guidelines#formatting|see the bottom of this page]]. A review section is just a wiki table. You are free to edit the table and/or add extra rows to the table. You can translate it into your own language. You can also copy and paste the page review table on this page to any of the wiki pages and edit accordingly
30 //
31 //
33 ===== Page Layout =====
35 There are some definite styles of pages to which we can bring a consistent layout.
37 === FAQ ===
39 This applies to one page, [[en:guides:faq|Frequently Asked Questions]].
41 - **Error Message** - title the individual FAQ with the most likely description, usually the error message displayed.
42 - **Symptoms** - a brief description of what the user may experience when this FAQ applies. There may be more than one. Use correct formatting when describing on-screen messages, keystrokes etc. Hopefully, Google results will pick this up.
43 - **Explanation** - a not-very-technical explanation of the error message. Users will be able to understand the problem and how it can be resolved in a high-level sense.
44 - **Solution** - how to solve the problem, technically. Include brief descriptions of the steps needed rather than merely a list of commands; this is important to understand what the user needs to do. Individual problems have slightly different solutions -- use levels of bullet points etc. to organise it.
47 === Guides ===
49 These resides under the <lang>:guides:<topic> name-space. They describe a process to get something working.
51 - **Introduction** - Summarize the article
52 - **Graphical Way**
53 * Instructions - How to use the graphical tool (if it exists)
54 * Screenshots - A picture is worth a thousand words
55 - **Manual Way**
56 * Installation - Define the packages required and how to install them
57 * Configuration - Explain how to configure files for the proper functioning of packages
58 * Summarize - If possible, summarize all commands in one single script for troubleshooting
59 - **Examples and Tips** - Add some examples and advanced tips
60 - **FAQ/Troubleshooting** - Some DIY instructions or a sub-section on problems/symptoms/solutions/notes or a link to forum posts. Link to FAQ if answered there
61 - **References** - Other good reference material on the Internet. If there aren't any, consider a message asking for some!
64 === Handbook ===
66 These reside under the <lang>:handbook:<topic> namespace. They brief the reader on what SliTaz can offer on a particular topic. They are an overview and description and not a guide, though they may contain (very) few steps on how to get up-and-running.
68 - **Blurb** - describes the content of the page, in terms of scope.
69 - **Topic** - what the user expects to achieve, e.g. 'Image Processing' or 'Desktop Themes'
70 - **Body Text** - an overview of the topic, with links to relevent Guides or external web pages.
71 - **Tips** (optional) - any problems the user may experience. Link to FAQ if answered, forum posts, good problem-solving web pages etc.
75 //
76 //
78 ===== Formatting =====
80 Please use correct formatting wherever possible. It aids readability and often lessens ambiguity between commands that should be entered vs. output etc.
82 * Learn wiki syntax [[http://doc.slitaz.org/wiki:syntax?s[]=playground | here]]. For testing wiki syntax, just use the [[http://doc.slitaz.org/en:guides:playground| Playground]] page
84 \\
85 ----
86 \\
87 ^ Page Review Section ^^
88 |Quality| Good |
89 |Review| Needs to be reviewed |
90 |Priority| Medium |
91 |Problems| add a [[http://forum.slitaz.org|forum post link]]|
92 |::: | OR add a [[http://labs.slitaz.org/issues |lab issue tracker link ]]|
93 |How to Improve| Suggest briefly, e.g.,|
94 |::: | [[http://labs.slitaz.org/wiki/packages | New package testing guidelines are here]] |
95 |::: | Add new rows like this ;-) |
97 \\
98 ----