Documentation Production

documentation-production

Use when generating, updating, or organizing documentation (component/API docs, project indexes, diagrams, tutorials, learning paths) - provides structured workflows and references for docs generation, indexing, diagrams, and teaching.

majiayu000/claude-skill-registry·0installs663starsProductivity & Planning

SKILL.md

Full skill instructions

Documentation Production

Overview

Provide a consistent, low-friction workflow for producing documentation across formats: focused docs, indexes, diagrams, tutorials, and learning paths. Keep outputs structured and aligned with the repo's docs conventions.

When to Use

Generating or updating documentation for components, APIs, or features
Building a project index or knowledge base
Creating Mermaid diagrams for system behavior or architecture
Writing tutorials, workshops, or learning paths
Explaining concepts for onboarding or education

Avoid when:

The request is primarily a code change (use implementation workflows)
The doc type is a one-off note that doesn't need structure

Quick Reference

Task	Load reference
Generate focused docs	`skills/documentation-production/references/generate.md`
Project index/knowledge base	`skills/documentation-production/references/index.md`
Mermaid diagrams	`skills/documentation-production/references/diagrams.md`
Teach concepts / learning paths	`skills/documentation-production/references/teacher.md`
Tutorials / workshops	`skills/documentation-production/references/tutorials.md`

Workflow

Identify doc type and target audience.
Load the relevant reference file(s) for structure and patterns.
Gather source material from code or existing docs.
Produce the artifact using the required format.
Validate accuracy and consistency with repo conventions.
Summarize changes and next steps.

Output

The documentation artifact(s)
Brief change summary and any follow-up gaps

Common Mistakes

Skipping source review and guessing behavior
Mixing tutorial/guide formats without clear intent
Creating diagrams without labels or accessibility notes
Updating docs without adjusting indexes or nav links

Install skill

Copy and run in your terminal

npx -y skills add https://github.com/majiayu000/claude-skill-registry --skill documentation-production

View on GitHub

skills/data/documentation-production/SKILL.md

More Productivity & Planning skills

View all

Productivity & Planning

brainstorming

Structured design dialogue that validates ideas before implementation begins.

295.4K 385.7K

View

Productivity & Planning

ui-ux-pro-max

Comprehensive design intelligence for web and mobile UI/UX across 10 technology stacks.

133.1K 383.9K

View

Productivity & Planning

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K

View

Productivity & Planning

using-superpowers

Introduction to the obra skills system with mandatory skill invocation rules and best practices.

295.4K 259.8K

View

Productivity & Planning

executing-plans

Execute a written implementation plan with critical review and task checkpoints.

295.4K 229.1K

View

Productivity & Planning

dispatching-parallel-agents

Delegate independent tasks to specialized agents working concurrently with isolated context.

295.4K 206.3K

View

Productivity & Planning

using-git-worktrees

Isolated git worktrees with smart directory selection and safety verification.

295.4K 205.2K

View

Productivity & Planning

webapp-testing

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

179.7K 170.6K

View