You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'd like to apply a writing style to the Surge XT manual, in line with, say Microsoft, GDS, or other style guides.
This does not include changes to the structure of the manual. The meaning of the information remains the same.
Guidance
Ideally, we should:
use plain English, using simple words and short sentences, for users whose first language is not English.
front-load headings and paragraphs, so users can vertically scan the first words of each line for what they need.
use consistent words to describe what the user does with the UI, like "select".
use present tense.
use active voice.
use macOS convention (Sentence Case) for UI labels.
display hierarchies of information in a structured way, rather than as multiline paragraphs.
use nouns for concepts, verbs for tasks (check whether we can do this without breaking links).
Draft pogress:
01
02
03
04
05
06
07
08
09
10
11
12
Tasks found
Should triage and move to issues:
CSS has greedy overrides and some bugs.
Patch browser screenshot needs update, to show the Undo UI.
Save dialog screenshot needs update, to show "Store tuning in patch"
Cross-reference MPE things (Dual/split, Status button, main menu).
Some cross-references (in Polyphony limit) should jump more precisely to related content. Use custom anchors, or create lower-level headings.
Make "Surge XT is best used..." active.
Mark external links with arrow, like Wikipedia does. Shall we force a new tab also?
The text was updated successfully, but these errors were encountered:
I'd like to apply a writing style to the Surge XT manual, in line with, say Microsoft, GDS, or other style guides.
This does not include changes to the structure of the manual. The meaning of the information remains the same.
Guidance
Ideally, we should:
Draft pogress:
Tasks found
Should triage and move to issues:
The text was updated successfully, but these errors were encountered: