Where to look if the Splunk Style Guide doesn't answer your question
Explore additional resources for grammar, style, and content design if the Splunk Style Guide can't answer your question.
The Splunk Style Guide covers issues specific to Splunk documentation, but standards for grammar, spelling, style, and content design are extensively covered in a number of other references.
| Writing standard | Resource |
|---|---|
| Best practices for product and user interface text | (Internal) Magnetic Design System https://magnetic.cisco.com/0a43ab5cd/p/583e31-content-design |
| Grammar and punctuation for nontechnical terms | The Chicago Manual of Style |
| Spelling, definitions, and capitalization | Merriam-Webster Dictionary |
| Other technical documentation style issues |
|
Writing references
| Reference | What's good about it |
|---|---|
| Every Page is Page One by Mark Baker and the Every Page is Page One website | This book and accompanying website provides guidelines for technical writers to create standalone, user-centric documentation that doesn't rely on a traditional hierarchical structure. |
| Writing Is Designing: Words and the User Experience by Michael J. Metts and Andy Welfle | This book and workshop series offers suggestions for collaboration between writers and designers in an effort to create user-centered experiences when designing digital products. |