name: documentation description: Documentation standards and patterns

Documentation Standards Index

Violet maintains separate documentation standards for external (customer-facing) and internal (team-facing) documentation.

External Documentation

For customer-facing documentation in the violetio/docs repository:

• See: External Documentation Standards
• Covers: API documentation, user guides, publishing workflows
• Publishing: GitBook with GitHub Sync auto-deployment
• Repository: violetio/docs

Internal Documentation

For internal documentation in prism-brain and code repositories:

• See: Internal Documentation Standards
• Covers: Architecture decisions, code comments, runbooks
• Publishing: Standard git workflow, version control
• Repositories: prism-brain, code repos

When to Use Which

Shared Principles

Both external and internal documentation follow these writing principles:

• Use clear, direct language
• One idea per sentence
• Prefer active voice
• Use headings, lists, and tables for structure
• Document maintenance dates
• Link to related documentation