How does this skill help with API documentation?

It provides specific standards for external-facing documentation, including workflows for publishing to GitBook via GitHub Sync.

What writing principles does the skill enforce?

It promotes clear, direct language, one idea per sentence, active voice, and the use of headings, lists, and tables for structure.

Does it support internal code documentation?

Yes, it includes guidelines for documenting internal systems, code comments, and architectural decisions within private repositories.

When should I use the external versus internal standards?

Use external standards for customer-facing features and APIs; use internal standards for code comments, runbooks, and architectural decisions.

Documentation Standards

Name: Documentation Standards
Author: violetio

byvioletio

•

Content Management

Standardizes internal and external documentation workflows using consistent patterns and domain-specific best practices.

The Documentation Standards skill provides a structured framework for managing both customer-facing and internal documentation within the Violet ecosystem. It distinguishes between external documentation hosted on GitBook and internal architectural decisions or runbooks stored within code repositories. By enforcing specific writing principles—such as active voice, structured headings, and maintenance tracking—this skill ensures that all technical content remains clear, accessible, and professional regardless of the target audience.

Key Features

01Integrates with GitBook and GitHub Sync publishing workflows

02Enforces shared writing principles including active voice and direct language

03Differentiates between external customer-facing and internal team-facing standards

04Provides patterns for Architectural Decision Records (ADRs) and operational runbooks

051 GitHub stars

06Includes maintenance tracking and structured linking patterns for related docs

Use Cases

01Drafting public API documentation and user guides for the violetio/docs repository

02Standardizing code comments and developer-facing documentation across repositories

03Recording internal architectural decisions and system runbooks in prism-brain

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add violetio/violet-ai-plugins documentation

For use in Claude.ai and ChatGPT

Download Skill