Wiki Standards & Style Guide
BookStack User Docs
https://www.bookstackapp.com/docs/user/content-overview/
Basic Do's and Dont's
| Do | Don't |
| Embed links to other wiki pages that exist as supplemental instructions/information which are relevant to your guide, but not specific to it | Reiterate instructions or reference material which exists as their own wiki page |
Paste text without the source formatting (CTRL + Shift + V), then apply formatting within the wiki's page editor |
Paste text with source formatting (CTRL + V). Fonts, text color, and background colors vary depending on each system's and user's personal settings |
| Use AP title case for page titles and headers | Use inconsistent or incorrect capitalization in page titles and headers |
|
Call attention to UI elements by either bolding them, or using an inline image of the UI element when writing instructions. For example:
or
|
Use screenshots of an entire page in order to visualize or label UI elements for step by step instructions, unless there is a good reason to. |
Technical Writing Resources
| Provider | Link(s) |
| Microsoft | |
| Apple |
Recommended Tools
| Provider | Link(s) | Notes |
| ScreenToGif | Useful for making quick GIFs to demonstrate navigating UIs |