Difference between revisions of "Wiki style guidelines"
| Line 11: | Line 11: | ||
* [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet <big>Wikipedia editing Cheatsheet</big>] | * [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet <big>Wikipedia editing Cheatsheet</big>] | ||
| − | == Exceptions == | + | == Exceptions from Wikipedia == |
=== Non English language articles === | === Non English language articles === | ||
| Line 18: | Line 18: | ||
=== Procedures === | === 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 [https://docs.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions Writing step-by-step instructions]. | 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 [https://docs.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions Writing step-by-step instructions]. | ||
| + | |||
| + | ====Procedure titles==== | ||
| + | Use gerunds (. . . ing) for procedural titles. For example, "Back up your wallet" should be "Back'''ing''' up your wallet". | ||
=== Tabs, buttons and UI elements === | === 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" | 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" | ||
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 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"
