Writing consistent, clear documentation takes effort, especially when multiple authors contribute to your knowledge base. Different writing styles, terminology choices, and formatting preferences can make your content feel disjointed and unprofessional.
Our Style guide feature makes it easy to maintain professional, consistent documentation as both your knowledge base and team expand. Use a straightforward rich-text editor to create and customize a style guide tailored to your organization's voice, terminology, and formatting standards. Then, use AI to check articles against your style guide to ensure consistency across your documentation.
What you can do
Use our Style guide to:
- Create a customized style guide using a rich-text (WYSIWYG) editor (up to 5,000 characters):
- Start from a style guide template or build your own style guide from scratch
- Reference established style guides and document only your exceptions
- Use AI to automatically review article content against your style guide
- Review AI-generated suggestions for style guide compliance
- Apply style guide standards when generating new articles with AI
Start using the Style guide
Ready to create consistent, on-brand documentation?
- Create a style guide: Go to KB settings > Style guide and select Create style guide. Not sure where to start? Check out Style guide starters for templates and approaches.
- Set up access controls: Make sure the right authors have permission to use the style guide features.
- Review content: Use AI or manual reviews to check articles against your style guide.
- Generate compliant content: When creating new articles with AI, check the Apply style guide checkbox to ensure generated content follows your guidelines from the start.
