Welcome to our style guide cheat sheet. This handy resource is designed to quickly guide you to the most essential pages within our style guide, based on our team's most frequently referenced pages. Consider this a companion to the main left-hand table of contents, where it may be hard to find what you're looking for.
Topic | Description | Style guide doc |
|---|---|---|
Word choice | Word usage guidelines for things like update vs. upgrade, e.g. and i.e., and version numbering. | |
Capitalization and punctuation | Learn what to capitalize (and what not to) for products, capabilities, and features. | |
Components | How to use components like tables, buttons, and callouts. | |
Images | How to handle screenshots, images, and embedding visuals within your docs. | |
Docs-as-code essentials | Learn the structure of the docs site, how set up local environments, and go through workflows for writing and editing docs. | |
Templates | Templates and guidelines for writing different documentation types such as troubleshooting guides and release notes. | |
Hero-ing | Information about GitHub processes, merging, and the role of a Docs hero. |