Skip to content
Skills Library
Programming · Writing

docs

/docs

Write or revise technical documentation around one reader job: reference, operation, review, decision, or product alignment. Use for READMEs, API docs, operational how-tos, RFCs, product design docs, architecture proposals, and ADRs.

Repository
Skills ↗
Licence
MIT
Last repository change
25.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
7
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 25.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Write or revise technical documentation around one reader job: reference, operation, review, decision, or product alignment. Use for READMEs, API docs, operational how-tos, RFCs, product design docs, architecture proposals, and ADRs.

Original author description

Write or revise technical documentation around one reader job: reference, operation, review, decision, or product alignment. Use for READMEs, API docs, operational how-tos, RFCs, product design docs, architecture proposals, and ADRs.

How it works

  1. Boundaries
  2. Workflow
  3. References
Original SKILL.md headings · 83 lines, 537 words
SKILL.md preview
---
name: docs
description: "Write or revise technical documentation around one reader job: reference, operation, review, decision, or product alignment. Use for READMEs, API docs, operational how-tos, RFCs, product design docs, architecture proposals, and ADRs."
---

# Technical Documentation Writer

Write for the reader's job: what they came to understand, decide, or do. A technically correct doc
that does not serve that job is still a failed doc.

## Boundaries

- Use `blog` for publishable articles with an argument, story, or public-facing lesson.
- The user-invoked `teach` skill owns persistent learning workspaces and HTML lessons.
- Use this skill for reference docs, team proposals, decision records, READMEs, API docs, and
  how-to docs whose primary purpose is work, review, or operation.

## Workflow

### 1. Name the doc type and reader job

Identify the document type before drafting: README, API docs, how-to, RFC or architecture proposal,
product design doc, or ADR.

Complete when:

- the doc type is named
- the primary audience is named
- the reader job is stated as `Reader needs to <do/decide/understand> so they can <outcome>`
- missing inputs are requested before drafting

### 2. Load the matching reference

Use the routing table below. If a template or type-specific rule applies, load that reference before
writing.

Complete when the matching reference has been loaded, or no reference applies and that is stated.

### 3. Gather the minimum context

Ask only for context needed by the reader job:

- current state and desired outcome
- constraints, dependencies, and owners
- concrete examples, commands, APIs, or decisions
- known errors, risks, alternatives, or non-goals

Complete when every required placeholder in the selected template has either source material or an
explicit `TBD`/question for the user.

### 4. Draft for use, review, or decision

Lead with what the reader needs first. Show before explaining when the reader must do something;
state the decision or proposal before deep rationale when the reader must decide.

Complete when:

- the opening answers the reader job
- every section exists to help the reader do, decide, or understand something
- examples are realistic and include required setup/config/error handling when relevant
- uncertainties are marked instead of invented

### 5. Run the quality gate

Before delivering, verify:

- [ ] First sentence says what this is or what decision/proposal is being made
- [ ] Code examples or commands were run when an environment is available; otherwise marked unverified
- [ ] Required config, inputs, env vars, and permissions are documented
- [ ] Common errors or risks include what to do next
- [ ] Links referenced in the doc were checked when accessible
- [ ] Terminology is consistent: one name per concept
- [ ] No "simple" / "just" / "easy" for user actions

Complete when all applicable checks pass or failures are called out explicitly.

## References

| Priority | Load when | Reference |
| --- | --- | --- |
| 1 | Decision already made; capture context, decision, and consequences | `references/adr-template.md` |
| 1 | Change not decided; solicit review, including system design with migration concerns | `references/rfc-template.md` |
| 1 | Scoping new product work with goals, non-goals, user stories, and metrics | `references/design-doc-template.md` |
| 2 | Creating or revising a README | `references/readme-guide.md` |
| 2 | Creating or revising API documentation | `references/api-docs-guide.md` |
| 2 | Creating or revising a task-oriented how-to guide | `references/how-to-guide.md` |
Files in this package (7)
  • SKILL.md 4 KB
  • references/adr-template.md 2 KB
  • references/api-docs-guide.md 1 KB
  • references/design-doc-template.md 3 KB
  • references/how-to-guide.md 1 KB
  • references/readme-guide.md 1 KB
  • references/rfc-template.md 4 KB

Versions

RepositoryScoreLicence
This page · kriscard/Skills100MIT
tanstack/ai100MIT
mthines/agent-skills100MIT
lilly-logic-labs/lll-skills100MIT
kriscard/kriscard-claude-plugins100MIT
imgly/agent-skills100MIT
The01Geek/prflow100MIT
grimoire-rs/grimoire100Apache-2.0
joestump/claude-plugin-sdd100MIT

Database snapshot: 13.11.2026 · package version 082a2c0fb3d1 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100documentation
    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.
  • 90Technical Writing
    Use for writing technical documentation - architecture decision records, RFCs and design docs, READMEs, API references, tutorials and how-to guides, runbooks, changelogs and release notes, and developer documentation. Also covers information architecture, audience calibration,…
  • 100technical-spec
    Technical specification and design document expert. Use when writing design docs, RFCs, ADRs, or evaluating technology choices. Covers C4 model, system design, and architecture documentation.
  • 100document
    Technical documentation expert for creating clear, comprehensive documentation including API docs (OpenAPI), ADRs, system architecture docs, developer guides, and runbooks. Use when creating or improving technical documentation.
  • 100design-docs
    Writes and reviews technical design documents (RFCs) and Architecture Decision Records (ADRs) with goals and non-goals, real alternatives, risks, security, rollout, rollback and observability. Use when planning a new system, service or major feature, choosing between…
  • 100documentation
    Use this skill when the user asks you to write, update, or fix project documentation — READMEs, API docs, user guides, ADRs, or other Markdown docs. Also use when code changes need user-facing docs updates. Only write Markdown files; do not use for implementation, planning or test work.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.