A few principles to follow when writing documentation:
Short. Keep the content easy to skim and quickly learn. Use content words in section headers and page titles for easier reading.
Actionable. Don’t be too verbose. Assume readers don’t have much patience digging through docs.
Modular. Write content that is self-contained and tight in scope. Have more, smaller pages under high-level topics.
Interconnected. Heavily cross-reference other pages in our docs and in external docs. Help readers discover other related topics and content.
When referring to a user interface, mark elements the reader sees or clicks with {gui}`Button text`. To show spaced menu paths, separate items with -> or just > (e.g. {gui}`One > Two > Three`).
If you need an icon, use {icon}`prefix:name` (uses the Iconify plugin).
If you need key-strokes, use {kbd}`Buttonname`.