documentation-strategy

Featured

Design and run a documentation system for a team or product. Use this skill when planning what to document, choosing a documentation tool, organizing existing docs, fixing stale documentation, designing a maintenance cadence, or scoping technical writing work. Triggers on documentation, docs, tech writing, knowledge base, wiki, runbook, README, internal docs, doc audit, doc maintenance, stale docs, where do we document. Also triggers when the team is repeatedly answering the same questions or when onboarding takes too long.

AI & Automation 501 stars 64 forks Updated 6 days ago MIT

Install

View on GitHub

Quality Score: 97/100

Stars 20%
90
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Strategy Decide what gets documented, where, by whom, and how it stays fresh. Stack-agnostic. Applies to internal team docs, product docs, runbooks, READMEs, and knowledge bases. --- ## When to use - Setting up documentation for a new team or product - Auditing existing documentation - Fixing stale or scattered docs - Choosing a documentation tool or platform - Defining what gets documented and what doesn't - Establishing maintenance cadence - Scoping technical writing work - Designing onboarding documentation (use alongside `team-onboarding-playbook`) ## When NOT to use - Writing the actual content of a single document (use `content-and-copy`) - Customer-facing knowledge base copy (use `content-strategy`) - Code comments and inline documentation (covered by `code-review-web`) - One-off blog posts or articles (use `content-and-copy`) --- ## Required inputs - The audience (internal, external, customer, dev, exec) - Existing docs and their state (where, what shape, last updated) - Team size and growth trajectory - The kinds of work that produce documentation (engineering, product, ops, support) - Tools currently in use --- ## The framework: 4 categories of documentation Different categories of doc serve different purposes. Conflating them is how docs get bad. ### Category 1: Reference What things are. Looked up when needed. Examples: API reference, configuration options, glossary, architecture diagrams, contact lists, decision log entries. Proper...

Details

Author
rampstackco
Repository
rampstackco/claude-skills
Created
3 months ago
Last Updated
6 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category