# Wiki



# Wiki Standards & Style Guide

### BookStack User Docs

[https://www.bookstackapp.com/docs/user/content-overview/](https://www.bookstackapp.com/docs/user/content-overview/)

### Basic Do's and Dont's

<table border="1" id="bkmrk-do-don%27t-embed-links" style="border-collapse: collapse; width: 100%; height: 232.917px;"><tbody><tr style="height: 29.7917px;"><td style="width: 49.9383%; height: 29.7917px; background-color: #ecf0f1;">**Do**</td><td style="width: 49.9383%; height: 29.7917px; background-color: #ecf0f1;">**Don't**</td></tr><tr style="height: 63.375px;"><td style="width: 49.9383%; height: 63.375px;">Embed links to other wiki pages that exist as supplemental instructions/information which are relevant to your guide, but not specific to it</td><td style="width: 49.9383%; height: 63.375px;">Reiterate instructions or reference material which exists as their own wiki page</td></tr><tr style="height: 63.375px;"><td style="width: 49.9383%; height: 63.375px;">Paste text **without** the source formatting (`CTRL` *+* `Shift` *+* `V`), then apply formatting within the wiki's page editor</td><td style="width: 49.9383%; height: 63.375px;">Paste text with source formatting (`CTRL` *+* `V`). Fonts, text color, and background colors vary depending on each system's and user's personal settings</td></tr><tr style="height: 46.5833px;"><td style="width: 49.9383%; height: 46.5833px;">Use AP title case for page titles and headers</td><td style="width: 49.9383%; height: 46.5833px;">Use inconsistent or incorrect capitalization in page titles and headers</td></tr><tr style="height: 29.7917px;"><td style="width: 49.9383%; height: 29.7917px;">Call attention to UI elements by either bolding them, or using an inline image of the UI element when writing instructions. For example:

1. *Click the **Save** button*

or

1. *Click the [![image-1662652350057.png](https://wiki.sumnersd.org/uploads/images/gallery/2022-09/scaled-1680-/image-1662652350057.png)](https://wiki.sumnersd.org/uploads/images/gallery/2022-09/image-1662652350057.png) button*

</td><td style="width: 49.9383%; height: 29.7917px;">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.</td></tr></tbody></table>

### Technical Writing Resources

<table border="1" id="bkmrk-provider-link%28s%29-goo" style="border-collapse: collapse; width: 100%; height: 249.781px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.4583px;"><td style="background-color: rgb(236, 240, 241); height: 29.4583px;">Provider</td><td style="background-color: rgb(236, 240, 241); height: 29.4583px;">Link(s)</td></tr><tr style="height: 58.5104px;"><td style="height: 58.5104px;">Google</td><td style="height: 58.5104px;">- [https://developers.google.com/style](https://developers.google.com/style)

</td></tr><tr style="height: 80.9062px;"><td style="height: 80.9062px;">Microsoft</td><td style="height: 80.9062px;">- [https://learn.microsoft.com/en-us/style-guide/welcome/](https://learn.microsoft.com/en-us/style-guide/welcome/)

</td></tr><tr style="height: 80.9062px;"><td style="height: 80.9062px;">Apple</td><td style="height: 80.9062px;">- [https://support.apple.com/guide/applestyleguide/welcome/web](https://support.apple.com/guide/applestyleguide/welcome/web)

</td></tr></tbody></table>

### Recommended Tools 

<table border="1" id="bkmrk-provider-link%28s%29-not" style="border-collapse: collapse; width: 100%; height: 87.9687px;"><colgroup><col style="width: 20.7578%;"></col><col style="width: 36.3409%;"></col><col style="width: 42.86%;"></col></colgroup><tbody><tr style="height: 29.4583px;"><td style="background-color: rgb(236, 240, 241); height: 29.4583px;">Provider</td><td style="background-color: rgb(236, 240, 241); height: 29.4583px;">Link(s)</td><td style="background-color: rgb(236, 240, 241);">Notes</td></tr><tr style="height: 58.5104px;"><td style="height: 58.5104px;">ScreenToGif</td><td style="height: 58.5104px;">- [https://www.screentogif.com/](https://www.screentogif.com/)

</td><td>Useful for making quick GIFs to demonstrate navigating UIs</td></tr></tbody></table>