Documentation standards and patterns
This skill inherits all available tools. When active, it can use any tool Claude has access to.
Violet maintains separate documentation standards for external (customer-facing) and internal (team-facing) documentation.
For customer-facing documentation in the violetio/docs repository:
violetio/docsFor internal documentation in prism-brain and code repositories:
prism-brain, code repos| Scenario | Use |
|---|---|
| Writing API documentation for external developers | External Standards |
| Documenting user-facing features/workflows | External Standards |
| Writing code comments for future developers | Internal Standards |
| Recording architectural decisions | Internal Standards |
| Creating operational runbooks | Internal Standards |
| Documenting internal systems | Internal Standards |
Both external and internal documentation follow these writing principles: