docs-writer
Skill1 starsChanged 5 months agoMITView on GitHub
Use when completed or in-progress work needs documentation such as README updates, migration notes, release notes, usage examples, or developer-facing operational guidance. This skill writes docs grounded in the current code and verified behavior.
28 other projects use a version of this.
Adopted by
Most recently taken up by
- delorenj/skillstheir own version, first seen Nov 7, 2026
- adeonir/agent-skillstheir own version, first seen Nov 6, 2026
- flightctl/ai-workflowstheir own version, first seen Oct 22, 2026
- maximhq/bifrosttheir own version, first seen Oct 20, 2026
- archiforge/agent-crafttheir own version, first seen Oct 20, 2026
- munnam77/claude-for-solopreneurstheir own version, first seen Oct 20, 2026
Used with
Projects with it also use docs-planner, docs-reviewer and 3 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
strands-agentsSkilldocs-planner
Find the gaps in the Box documentation and produce a prioritized backlog for docs/user/ and docs/design/. Use when planning documentation work, after a feature or a binary ships without a page, for a periodic health check of the docs, or when asked "what docs need writing", "plan the docs work", "prioritize the docs backlog", or "what should we document next".
Also in 3 projects that use this
strands-agentsSkilldocs-reviewer
Review Box drafts in docs/user/ or docs/design/, and wording-only rewrites in docs/dev/. Use after docs-writer, before a docs pull request, or for a requested doc review. Check style and preservation of meaning, then give a Ship it, Tighten, or Rethink verdict. Read-only.
Also in 3 projects that use this
hiroppySkilldocs-audit
Audit docs/ design documents, specs, and implementation plans against current source code for drift. Outputs a drift report and updates documents. Triggers on "check if docs are up to date", "diff docs vs code", "update design docs", "docs consistency check", "verify specs match source", "check plan completion status". Most effective after code or documentation changes.
Also in 3 projects that use this
GoogleSkillcode-review
Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.
Also in 4 projects that use this
GoogleSkilltdd
Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.
Also in 3 projects that use this
Other versions28 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 28
- google-gemini/gemini-cli★ 109ksame name
- maximhq/bifrost★ 9.4ksame name
- strands-agents/sdk-python★ 9.1ksame name
- strands-agents/harness-sdk★ 8.9ksame name
- Devolutions/IronRDP★ 3.3ksame name
- prisma/docs★ 1.1ksame name
- prisma/web★ 1.1ksame name
- event-driven-io/emmett★ 562same name
- strands-agents/box★ 503same name
- Cosmian/kms★ 372same name
18 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository21 other files it gives its agents.
- api-contract-compatibility-reviewSkill
- architecture-refactor-guidanceSkill
- browser-verificationSkill
- change-impact-analysisSkill
- cost-impact-reviewSkill
- data-migration-safety-reviewSkill
- data-quality-auditSkill
- dependency-compliance-auditSkill
- environment-config-auditSkill
- fix-ciSkill
- incident-observability-triageSkill
- performance-investigationSkill
- planningSkill
- release-incident-postmortemSkill
- release-rollout-strategySkill
- review-address-commentsSkill
- security-reviewSkill
- ship-readinessSkill
- dev-workflow-kitSkill
- systematic-debuggingSkill
- test-strategy-gap-reviewSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 6 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 26 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Use this skill when project knowledge needs to be turned into durable documentation.
- Distinctive: line 13
Use this skill when:
- Distinctive: line 20
Do not use this skill to invent architecture or behavior that is not supported by the current code.
- Distinctive: line 24
Read the relevant code and existing docs first.
- Distinctive: line 27
Write the smallest docs that close the knowledge gap.
- Distinctive: line 42
use the active implementation workflow if the behavior is still changing
- Very specific: line 43
use ship-readiness if docs are part of release completion
- Very specific: line 44
use security-review if the docs touch sensitive operational guidance
“Common” is measured: kept by at least 6 in 10 of the 26 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Docs Writer
Use this skill when project knowledge needs to be turned into durable documentation.
Trigger Conditions
Use this skill when:
- README or setup docs need updates
- a change requires migration notes or release notes
- usage examples must be added
- implementation behavior should be documented for other developers
- the user asks for docs tied to real code changes
Do not use this skill to invent architecture or behavior that is not supported by the current code.
Workflow
- Read the relevant code and existing docs first.
- Identify the audience and purpose.
- Capture only the behavior that is real and current.
- Write the smallest docs that close the knowledge gap.
- Preserve examples and step ordering where they help.
- Note any missing verification if docs depend on untested behavior.
Output
For non-trivial work, provide:
- target audience
- docs updated or drafted
- source of truth consulted
- open gaps or assumptions
Coordination
Before documentation:
- use the active implementation workflow if the behavior is still changing
- use
ship-readinessif docs are part of release completion - use
security-reviewif the docs touch sensitive operational guidance
Invocation Examples
- "Use docs-writer to update the README for this new setup flow."
- "Use docs-writer to draft migration notes for this breaking change."
- "Use docs-writer to create a short release note and usage example."
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

