documentation-writer
Skill1 starsChanged 10 days agoMITView on GitHub
Write clear, scannable documentation with a research-first, phase-separated workflow. Pick one Diátaxis mode, then apply STE and Global English. Apply when the user asks for documentation, READMEs, doc sites, API reference, migration guides, or technical markdown. Use marketing-psychology for marketing copy. Use authoring-skills-and-rules to write a Skill, not a README. Not commit-message lint — changelog.mdc owns changelog headings.
43 other projects use a version of this.
Adopted by
Most recently taken up by
- FimawLLC/fimaw-skillstheir own version, first seen Nov 15, 2026
- compozy/compozytheir own version, first seen Nov 13, 2026
- evenfire-ai/evenfiretheir own version, first seen Nov 8, 2026
- The-Vibe-Company/quivrtheir own version, first seen Nov 8, 2026
- halilural/imprimaturtheir own version, first seen Nov 8, 2026
- ChristopherAlphonse/calphonse-skillstheir own version, first seen Nov 2, 2026
Used with
Projects with it also use tailwindcss, test-engineer and 10 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.
azlekovSkilltailwindcss
This skill should be used when the user asks to "style with Tailwind", "add CSS", "configure theme", "use @theme", "add custom colors", "implement dark mode", "use container queries", "add responsive design", "use OKLCH colors", or discusses styling, theming, or visual design. Always use the latest Tailwind CSS version and modern patterns.
Also in 3 projects that use this
JohnJBorenSkilltest-engineer
Testing strategy, test patterns, and coverage optimization for unit, integration, and E2E tests
Also in 4 projects that use this
LangChainSkillmermaid-diagrams
Embed Mermaid diagrams in generated wiki pages. Use whenever documenting a runtime or request flow, a call sequence, a state machine or lifecycle, a data model or entity relationships, or non-trivial control flow, since these are clearer as a diagram than as prose. Also use when an update run touches a page that already contains a mermaid fence, or a page that contains a text fence a previous run degraded.
Also in 5 projects that use this
JohnJBorenSkilldebugger
Systematic debugging workflows, root cause analysis, and troubleshooting patterns
Also in 3 projects that use this
GoogleSkillcode-reviewer
Also in 6 projects that use this
VercelSkilltechnical-writer
Write, review, and edit developer documentation for SDKs, libraries, and frameworks, including sites such as ai-sdk.dev and chat-sdk.dev. Use for getting-started guides, tutorials, API references, conceptual explanations, integration guides, migration guides, troubleshooting, and code examples.
Also in 3 projects that use this
Other versions43 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 43
- github/awesome-copilot★ 41ksame name
- QuivrHQ/quivr★ 40ksame name
- The-Vibe-Company/quivr★ 40ksame name
- dolanmiu/docx★ 6ksame name
- rajnandan1/kener★ 5.2ksame name
- compozy/compozy★ 2.9ksame name
- javierbrea/eslint-plugin-boundaries★ 1ksame name
- cboard-org/cboard★ 766same name
- mohebifar/tooscut★ 716same name
- pedronauck/skills★ 655same name
33 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 repository107 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .cursor/rules/base.mdcCursor rule
- .cursor/rules/changelog.mdcCursor rule
- .cursor/rules/comments.mdcCursor rule
- .cursor/rules/release.mdcCursor rule
- .cursor/rules/seo-ai-search.mdcCursor rule
- .cursor/rules/testing.mdcCursor rule
- agent-readySkill
- authoring-skills-and-rulesSkill
- blinded-evalSkill
- cloakbrowser-fallbackSkill
- deep-deliberationSkill
- design-rationaleSkill
- dissectSkill
- documentation-writerSkill
- everything-seoSkill
- executeSkill
- generating-app-verifySkill
- inceptionSkill
- kit-workflowsSkill
- marketing-psychologySkill
- media-genSkill
- nlm-skillSkill
- opinionSkill
- proving-change-safetySkill
- refreshing-app-verifySkill
- release-deploySkill
- seo-auditSkill
- startup-marketing-brainSkill
- subsystem-walkthroughSkill
- trlSkill
- unmatched-workflowSkill
- agent-readySkill
- authoring-skills-and-rulesSkill
- blinded-evalSkill
- cloakbrowser-fallbackSkill
- deep-deliberationSkill
- design-rationaleSkill
- dissectSkill
- everything-seoSkill
- executeSkill
- generating-app-verifySkill
- inceptionSkill
- kit-workflowsSkill
- marketing-psychologySkill
- media-genSkill
- nlm-skillSkill
- opinionSkill
- proving-change-safetySkill
- refreshing-app-verifySkill
- release-deploySkill
- seo-auditSkill
- startup-marketing-brainSkill
- subsystem-walkthroughSkill
- trlSkill
- unmatched-workflowSkill
- agent-readySkill
- authoring-skills-and-rulesSkill
- blinded-evalSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
4 rules. 0 are common, 3 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 42 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 41
Verify — examples run; citations still match.
- Very specific: line 49
If the host can launch a Task / explore subagent, use a read-only explore pass for a large or unfamiliar codebase before drafting.
- Distinctive: line 55
Read relevant files. Delegate broad mapping to explore when available.
- Distinctive: line 85
Start each section with the BLUF answer.
“Common” is measured: kept by at least 6 in 10 of the 42 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
Documentation Writer
Leading words: research-first, Diátaxis mode, BLUF, STE, Global English, evidence-aware, phase separation.
Research-first technical documentation. Chat stays Caveman; the document is Standard Professional Mode.
Copy these phases into the todo list verbatim. A skipped phase stays with
skip: <reason>.
- Discover — list every file/API/feature the docs must cover.
- Research — primary sources for versions, flags, install commands.
- Outline — name the Diátaxis mode; BLUF per section.
- Draft — STE / Global English; slop catalog for artifacts.
- Verify — examples run; citations still match.
Mode table: references/diataxis.md. Sentence craft: references/style.md. Slop ids: references/slop-catalog.md.
Subagents
If the host can launch a Task / explore subagent, use a read-only explore
pass for a large or unfamiliar codebase before drafting. Use web search for
anything version-sensitive. Do not assume those tools exist.
Phase 1 — Discover
Read relevant files. Delegate broad mapping to explore when available.
Exit: you can list every file/API/feature the docs must cover.
🛑 Do not proceed to Research until the user confirms the scope (or you are
explicitly operating solo and the scope is unambiguous). Ask with the host's
structured question tool. Prompt in plain English. Last option:
Say this in plain English (meta: rephrase + example, do not advance).
Phase 2 — Research
Web research before asserting facts about APIs, CLI flags, install commands, LTS timelines, or security claims. Prefer primary sources. Capture citations. If sources conflict, say what is uncertain.
Exit: every claim you will make has a source link. 🛑 Do not proceed to Outline until Research is complete.
Phase 3 — Outline
Name the Diátaxis mode. Headings, audience, prerequisites. BLUF: lead each section with the direct answer in 40–60 words.
Exit: skeleton approved.
🛑 Present the outline. Do not draft until confirmed. Ask with the host's
structured question tool. Prompt in plain English. Last option:
Say this in plain English (meta: rephrase + example, do not advance).
Phase 4 — Draft
Apply references/style.md and the slop catalog. Start each section with the BLUF answer. Tables for comparisons. Concrete examples first.
Exit: every outline section has content.
Phase 5 — Verify
Re-read against the repo. Re-check critical external claims. Run code examples when possible.
Exit: every example runs as documented; every external claim matches the cite.
Standard file shape
- Title + 1–2 sentence summary (BLUF).
- Quick start — exact commands.
- Usage / examples — most common case first.
- API / reference if needed — tables.
Reply contract
Name the Diátaxis mode, the files written, and any claim still unverified.
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.

