Documentation Standards
Last updated: Sep-04-2025
Caution
These docs are strictly for internal use only. They are only present in the development (docs-dev) and staging domains. There should be no external links to these pages, and links to these pages should not be shared externally. Overview
This section establishes the quality guidelines, style conventions, and content standards that ensure our documentation maintains consistency, clarity, and professionalism. These standards apply to all content creation, regardless of format or audience.
Important
These standards complement the technical guides in Site Usage & Technical Guides. While that section covers how to use our tools, this section focuses on what makes quality content.
On this page:
Guide Contents
Content Style Guide
Comprehensive writing standards and style conventions for all documentation:
- The 10 Commandments of Tech Content - Core principles for excellence
- Style Guide for Documenting UI - Guidelines for interface documentation
- Console Terminology and Guidelines - Conventions for terminology related to the account and Console
- CSS and Styling Guidelines - Word breaking and dark/light mode
- Disclaimers - Alpha and Beta disclaimers
Note
This is our primary reference for writing quality. Bookmark this page and refer to it regularly during content creation.Content Creation Guidelines
Detailed procedures and best practices for developing comprehensive content:
- Adding a New SDK or Integrations Guide - Special instructions for SDKs and integrations
- Documenting New Add-ons - Special instructions for add-on pages
- Video Tutorials - Screen standards and setup instructions
- Code Explorers Integration - How to add a StackBlitz code explorer
- Images & Videos in Docs & Posts - Legal requirements, guidelines, and valid graphic sources
Related topics
- Site Usage & Technical Guides - Technical implementation of these standards
- Team Resources & Workflows - Tools and collaboration methods
✖️
Error
Rate this page:
