Difference between revisions of "Wiki style guidelines"

From Bisq Wiki
Jump to navigation Jump to search
Line 17: Line 17:
  
 
=== Procedures  ===
 
=== Procedures  ===
The Bisq wiki contains many procedures. The Wikipedia Manual of Styles does not include styles technical tasks and procedures. Another style guide is in-process.
+
The Bisq wiki contains many procedures. The Wikipedia Manual of Styles does not include styles for technical tasks and procedures. The Microsoft style guide for procedures and instructions has excellent guidance [[https://docs.microsoft.com/en-us/style-guide/procedures-instructions/ Procedures and 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 09:11, 23 March 2020


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. The Microsoft style guide for procedures and instructions has excellent guidance [Procedures and 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"