Documentation Standards

This skill should be used when the user asks about "documentation templates", "doc structure", "README format", "API documentation format", "how to write tutorials", "documentation checklist", or when the documentation-writer agent needs templates and workflows for specific documentation types. Provides Diataxis-based templates, checklists, and examples for 7 documentation types.

8 stars 3 forksWriting & Content Plugin marketplace

Install

Claude Code plugin
/plugin marketplace add Freddy-CHEN-ux/00_claude_skills

The repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add Freddy-CHEN-ux/00_claude_skills --skill documentation-standards
Manual install
git clone --depth 1 https://github.com/Freddy-CHEN-ux/00_claude_skills.git /tmp/00_claude_skills
mkdir -p ~/.claude/skills
cp -r /tmp/00_claude_skills/skills/documentation-standards ~/.claude/skills/documentation-standards

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Documentation Standards

Templates, workflows, and checklists for creating documentation following Diataxis principles.

## When to Use This Skill

Use when:

- Creating any type of documentation
- Need template for specific doc type
- Want checklist to verify doc completeness
- documentation-writer agent needs HOW guidance

## Diataxis Framework Quick Reference

| Quadrant | Purpose | Audience | Focus |
|----------|---------|----------|-------|
| **Tutorial** | Learning | Beginners | Hand-holding, confidence building |
| **How-to** | Goal completion | Practitioners | Steps to achieve specific goal |
| **Reference** | Information | Any level | Exhaustive, accurate lookup |
| **Explanation** | Understanding | Curious users | WHY, context, decisions |

## Documentation Types Overview

| Type | Diataxis | When to Use | Guidelines | Template |
|------|----------|-------------|------------|----------|
| README (root) | How-to | Project entry point | `references/readme-guidelines.md` | `examples/readme-root-template.md` |
| README (module) | Reference + How-to | Module documentation | `references/readme-guidelines.md` | `examples/readme-module-template.md` |
| Quick Start | How-to | Fast path to working | `references/quickstart-guidelines.md` | `examples/quickstart-template.md` |
| CONTRIBUTING | How-to | Guide contributors | `references/contributing-guidelines.md` | `examples/contributing-template.md` |
Read the full skill on GitHub

Details

Skill name
documentation-standards
Path
skills/documentation-standards/SKILL.md
Repo updated
10 January 2026

FAQ

What does the Documentation Standards skill do?

This skill should be used when the user asks about "documentation templates", "doc structure", "README format", "API documentation format", "how to write tutorials", "documentation checklist", or when the documentation-writer agent needs templates and workflows for specific documentation types. Provides Diataxis-based templates, checklists, and examples for 7 documentation types.

How do I install the Documentation Standards skill?

Claude Code plugin: /plugin marketplace add Freddy-CHEN-ux/00_claude_skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Documentation Standards popular?

It lives in Freddy-CHEN-ux/00_claude_skills, which has 8 GitHub stars and 3 forks.

Related skills

Add Integration

8

Freddy-CHEN-ux/00_claude_skills

Build a new API integration for Nexus. Load when user mentions "add integration", "new integration", "integrate with", "connect to [service]", or "build [service] integration". Interactive workflow that discovers API endpoints, plans the integration, and creates a project for implementation.

Software Development

AI Agents

8

Freddy-CHEN-ux/00_claude_skills

Production-grade AI agent patterns with MCP integration, agentic RAG, handoff orchestration, multi-layer guardrails, and observability (modern best practices)

AI, LLMs & Agents

AI LLM

8

Freddy-CHEN-ux/00_claude_skills

Production LLM engineering skill. Covers strategy selection (prompting vs RAG vs fine-tuning), dataset design, PEFT/LoRA, evaluation workflows, deployment handoff to inference serving, and lifecycle operations with cost/safety controls.

AI, LLMs & Agents

Elements of Style

5

vnovakovits/claude-skills

Write clearly and concisely by applying William Strunk Jr.'s "The Elements of Style" (1918; Strunk & White from 1959) to any English prose — PR descriptions, commit messages, READMEs, ADRs, design docs, tickets, release notes, emails, chat replies, UI copy, error messages, code comments, marketing pages. Covers the rules of usage (commas, independent clauses, dangling participles), the principles of composition (one topic per paragraph, active voice, positive form, definite concrete language, omit needless words, parallel form, related words together, emphatic word last), the misused-words lis

Writing & Content

Docs Codebase

8

Freddy-CHEN-ux/00_claude_skills

Technical writing patterns for README files, API documentation, architecture decision records (ADRs), changelogs, contributing guides, code comments, and docs-as-code workflows. Covers documentation structure, style guides, Markdown best practices, and documentation testing.

Writing & Content

Example Mapping

5

vnovakovits/claude-skills

Apply Matt Wynne's Example Mapping — the four-colour discovery technique (yellow story, blue rules, green concrete examples, red questions) that breaks a story or spec into rules, hangs concrete examples under each rule, and surfaces open questions. Covers the 25-minute session, card conventions, shape-of-the-map diagnostics (a rule with no examples is under-specified; an example fitting no rule means a missing rule; a red-heavy map is not ready), AUDIT MODE for checking whether a written spec's examples cover its rules, building the map on Miro or as a document, and converting greens into acc

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.