documentation

Name: documentation
Author: anthropics

7.5kinstalls2.7kforks

How to install documentation?

anthropics/knowledge-work-plugins/documentation

$npx -y skills add anthropics/knowledge-work-plugins --skill documentation

Installs into the current project.

Summary

Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.

Files · 1

View on GitHub

SKILL.md

1	# Technical Documentation
2
3	Write clear, maintainable technical documentation for different audiences and purposes.
4
5	## Document Types
6
7	### README
8	- What this is and why it exists
9	- Quick start (< 5 minutes to first success)
10	- Configuration and usage
11	- Contributing guide
12
13	### API Documentation
14	- Endpoint reference with request/response examples
15	- Authentication and error codes
16	- Rate limits and pagination
17	- SDK examples
18
19	### Runbook
20	- When to use this runbook
21	- Prerequisites and access needed
22	- Step-by-step procedure
23	- Rollback steps
24	- Escalation path
25
26	### Architecture Doc
27	- Context and goals
28	- High-level design with diagrams
29	- Key decisions and trade-offs
30	- Data flow and integration points
31
32	### Onboarding Guide
33	- Environment setup
34	- Key systems and how they connect
35	- Common tasks with walkthroughs
36	- Who to ask for what
37
38	## Principles
39
40	1. Write for the reader — Who is reading this and what do they need?
41	2. Start with the most useful information — Don't bury the lede
42	3. Show, don't tell — Code examples, commands, screenshots
43	4. Keep it current — Outdated docs are worse than no docs
44	5. Link, don't duplicate — Reference other docs instead of copying

People who liked this also viewed

6 picks

Type

documentation

7.5kinstalls2.7kforks

View on GitHub

How to install documentation?

anthropics/knowledge-work-plugins/documentation

$npx -y skills add anthropics/knowledge-work-plugins --skill documentation

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Technical Documentation
2
3	Write clear, maintainable technical documentation for different audiences and purposes.
4
5	## Document Types
6
7	### README
8	- What this is and why it exists
9	- Quick start (< 5 minutes to first success)
10	- Configuration and usage
11	- Contributing guide
12
13	### API Documentation
14	- Endpoint reference with request/response examples
15	- Authentication and error codes
16	- Rate limits and pagination
17	- SDK examples
18
19	### Runbook
20	- When to use this runbook
21	- Prerequisites and access needed
22	- Step-by-step procedure
23	- Rollback steps
24	- Escalation path
25
26	### Architecture Doc
27	- Context and goals
28	- High-level design with diagrams
29	- Key decisions and trade-offs
30	- Data flow and integration points
31
32	### Onboarding Guide
33	- Environment setup
34	- Key systems and how they connect
35	- Common tasks with walkthroughs
36	- Who to ask for what
37
38	## Principles
39
40	1. Write for the reader — Who is reading this and what do they need?
41	2. Start with the most useful information — Don't bury the lede
42	3. Show, don't tell — Code examples, commands, screenshots
43	4. Keep it current — Outdated docs are worse than no docs
44	5. Link, don't duplicate — Reference other docs instead of copying

People who liked this also viewed

6 picks

Type