Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 3.61 KB

userGuideStandards.md

File metadata and controls

108 lines (79 loc) · 3.61 KB
Raw

User Guide Standards

This document aims to create a standard style guide for writing documentation in the User Guide.

The principles outlined in "The Documentation System" guide for reference materials are encouraged when working on the User Guide and this document.

General standards

  • Key commands (e.g. NVDA+control+upArrow):
    • should be written in lowerCamelCase
    • encapsulated in monospace code-block formatting
    • NVDA should be capitalized
  • When referring to Windows terminology, follow the Windows style guide.
    • For instance, instead of "system tray" refer to "notification area"

Feature settings

Feature flags, comboboxes and checkboxes should be included using the following format.

FeatureDescriptionAnchor should not include the settings category. Once the anchor is set it cannot be updated, while settings may move categories.

==== The name of a feature ====[FeatureDescriptionAnchor]


| . {.hideHeaderRow} |.|
|---|---|
|Options |Default (Enabled), Disabled, Enabled|
|Default |Enabled|
|Toggle command |`NVDA+shift+e` |

|Option |Behaviour |
|---|---|
|Enabled |behaviour of enabled |
|Disabled |behaviour of disabled |

This setting allows the feature of using functionality in a certain situation to be controlled in some way.
If necessary, a description of a common use case that is supported by each option.

Generation of Key Commands

Generation of the Key Commands document requires certain commands to be included in the User Guide. These commands must begin at the start of the line and take the form:

<!-- KC:command -->
<!-- KC:command: arg -->

The title command must appear first. The other commands are used to select content containing key commands to be included into the key commands document. Appropriate headings from the User Guide will be included implicitly.

Specifying the title

The KC:title command must appear first and specifies the title of the Key Commands document.

For example:

<!-- KC:title: NVDA Key Commands -->

Selecting blocks

The KC:beginInclude command begins a block of text which should be included verbatim. The block ends at the KC:endInclude command.

For example:

<!-- KC:beginInclude -->
| Name | Desktop command | Laptop command | Description |
...
<!-- KC:endInclude -->

Headers for settings sections

The KC:settingsSection command indicates the beginning of a section documenting individual settings. It specifies the header row for a table summarising the settings indicated by the KC:setting command (see below). In order, it must consist of a name column, a column for each keyboard layout and a description column.

For example:

<!-- KC:settingsSection: || Name | Desktop key | Laptop key | Description | -->

Including a setting

The KC:setting command indicates a section for an individual setting.

It must be followed by:

  • A heading containing the name of the setting;
  • A table row for each keyboard layout, or if the key is common to all layouts, a single line of text specifying the key after a colon;
  • A blank line; and
  • A line describing the setting.

For example:

<!-- KC:setting -->
#### Braille Tethered To

| . {.hideHeaderRow} |.|
|---|---|
| Desktop command | `NVDA+control+t` |
| Laptop Command | `NVDA+control+t` |

This option allows you to choose whether the braille display will follow the system focus, or whether it follows the navigator object / review cursor.