Difference between revisions of "Wiki style guidelines"
| Line 3: | Line 3: | ||
__TOC__ | __TOC__ | ||
== General guidelines == | == General guidelines == | ||
| − | The Bisq wiki adheres to the Wikipedia Manual of Style whenever possible. There are some styles that Wikipedia does not cover, such as Tasks and Procedures, they will be documented in '''Exceptions''' below. <!-- Wikipedia has an extensive Manual of Styles we should leverage it whenever possible and only document exceptions. --> | + | The Bisq wiki adheres to the Wikipedia Manual of Style whenever possible. There are some styles that Wikipedia does not cover, such as Tasks and Procedures, they will be documented in '''Exceptions from Wikipedia''' below. <!-- Wikipedia has an extensive Manual of Styles we should leverage it whenever possible and only document exceptions. --> |
* [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style <big>Wikipedia Manual of Style</big>] | * [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style <big>Wikipedia Manual of Style</big>] | ||
Revision as of 06:47, 26 March 2020
Contents
General guidelines
The Bisq wiki adheres to the Wikipedia Manual of Style whenever possible. There are some styles that Wikipedia does not cover, such as Tasks and Procedures, they will be 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".
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", not "click the Start button"
