Writing documentation

• Documentation systems
  • Developer and sysadmin documentation
  • Core website documentation
  • User-facing documentation
    • Help center documentation
    • Integrations documentation
    • API documentation
  • Automated testing
• Writing help center articles
  • Guide to writing help center articles
    • Getting started
    • Updating an existing article
    • Adding a new article
    • Redirecting an existing article
  • Writing style
    • User interface
    • Voice
    • Keyboard shortcuts
  • Markdown features
    • Images
    • Icons
    • Macros
    • Tips and warnings
    • Tab switcher
• Documenting an integration
  • Markdown macros
  • Writing guidelines
    • General writing guidelines
    • Guidelines for specific steps
    • Screenshots
• Documenting REST API endpoints
  • How it works
    • Title and description
    • Usage examples
    • Parameters
    • Response with examples
  • Step by step guide
  • Why a custom system?
  • Debugging schema validation errors
    • Deconstructing the error output
    • Adding a realm setting
• OpenAPI configuration
  • Working with the zulip.yaml file
    • Configuration
    • Endpoint definitions
    • Schemas
  • Zulip Swagger YAML style:
  • Tips for working with YAML:
    • Formatting help:
    • Examples: