Difference between revisions of "Wiki style guidelines"
| Line 17: | Line 17: | ||
=== 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 | + | 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]. |
=== 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:41, 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
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.
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"
