Documentation Style Guide
Documentation contributions should uphold the following style rules.
Write as an expert on the software, rather than one of its maintainers. This encourages contributions. For example, instead of “we decided to change…”, use “Workarea 3.3 changes…”.
Titles & Headings
The title of each document and the heading of each document section should describe either a concept or the procedure to complete a task. Use nouns for titles and headings that represent concepts. Use verbs to represent tasks.
Capitalize the first word and important words.
- Orders & Items
- Placing Orders
- Add System Content
- Release a Plugin
- Export Orders
- Place an Order
Try to limit outline depth to three levels (h1-h3). If you find yourself needing a deeper outline, consider re-organizing the content into multiple documents.
Names of software packages, such as Admin and Storefront are proper nouns, which are capitalized.
Names of features are not proper nouns and are not capitalized. Examples:
- Admin toolbar
Spelling & Grammar
At this time there are no prescribed style rules regarding spelling, grammar, and language. However, always use a spell checker before submitting contributions.
How'd We Do?
If you found this article was missing information or wasn't quite what you were looking for, we are open to any suggestions or feedback on what we could do better.Help Us Out