Difference between revisions of "Wiki style guidelines"
| Line 9: | Line 9: | ||
* References | * References | ||
| − | For clarity | + | For clarity it is best that these three types of information not be intermingled. For example, you do not want to step through a lengthy task to find a file name. |
An example of a good procedure is [https://bisq.wiki/Backing_up_your_wallet Backing up your wallet]. It has a title with a gerund (Back'''ing'''), and a brief conceptual introduction followed by a step-by-step task. | An example of a good procedure is [https://bisq.wiki/Backing_up_your_wallet Backing up your wallet]. It has a title with a gerund (Back'''ing'''), and a brief conceptual introduction followed by a step-by-step task. | ||
Revision as of 07:21, 26 March 2020
Contents
General guidelines
There are three general types of information that almost every form of information can be segregated into:
- Concepts
- Tasks (procedures)
- References
For clarity it is best that these three types of information not be intermingled. For example, you do not want to step through a lengthy task to find a file name.
An example of a good procedure is Backing up your wallet. It has a title with a gerund (Backing), and a brief conceptual introduction followed by a step-by-step task.
Style guide references
The Bisq wiki adheres to the Wikipedia Manual of Style whenever possible. There are some styles that Wikipedia does not cover.They are documented in Exceptions from Wikipedia below.
Exceptions from Wikipedia
Non English language articles
Until there is a need for separate language wikis, create articles in the non English language with the English translation in comments. See Running Bisq in China as an example.
Procedures
The Bisq wiki contains many procedures. The Wikipedia Manual of Styles does not include styles for technical tasks and procedures therefore the Microsoft style guide has excellent guidance for Writing step-by-step instructions.
Procedure titles
Use gerunds (. . . ing) for procedural titles. For example, "Back up your wallet" should be "Backing up your wallet". Using a gerund implies you will be performing a process.
Tabs, buttons and UI elements
User interface (UI) elements such as tabs and buttons are indicated in bold text. When referring to an action, simply state "click Start", do not state "click the Start button".
