Can I use this for API documentation?

Yes, it includes specific patterns for customer-facing API documentation and user guides designed for external developer consumption.

How does this skill differentiate between internal and external docs?

The skill identifies the repository context (e.g., violetio/docs vs. prism-brain) and applies specific standards for publishing workflows, such as GitBook for external users or standard Git workflows for internal teams.

Is it compatible with GitBook?

Yes, the external documentation standards are specifically designed to work with GitBook via GitHub Sync auto-deployment.

What writing style does this skill promote?

It enforces clear, direct language using active voice, one idea per sentence, and structured formatting using headings, lists, and tables.

Does it support Architectural Decision Records (ADRs)?

Yes, it provides standards for internal documentation which specifically covers recording architectural decisions and system design.

Documentation Standards

Name: Documentation Standards
Author: violetio

byvioletio

0•

Learning & Documentation

Standardizes technical writing by enforcing specific patterns for internal team documentation and external customer guides.

This skill empowers Claude to act as a professional documentation specialist, ensuring all technical writing aligns with the specific organizational standards of the Violet ecosystem. It provides clear branching logic for different content types: external customer-facing documentation stored in GitBook-synced repositories, and internal team-oriented resources like architectural decisions (ADRs) and runbooks. By applying shared principles such as active voice, concise sentence structure, and structured formatting, the skill ensures that all project documentation remains professional, accessible, and maintainable across various repositories.

Key Features

01Standardizes Architectural Decision Records (ADRs) and operational runbooks

02Enforces distinct standards for internal and external documentation workflows

03Promotes high-quality technical writing via active voice and structural patterns

04Optimizes content for GitBook and GitHub Sync auto-deployment

05Provides repository-specific guidance for docs, prism-brain, and code repos

060 GitHub stars

Use Cases

01Generating external API documentation and user-facing feature guides

02Recording internal architectural decisions and system design patterns

03Drafting operational runbooks and developer-facing code comments

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