documentation-writer
Skill0 starsChanged 47 days agoMITView on GitHub
Document verified behavior and setup without inventing details.
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
- afaraha8403/balakittheir own version, first seen Nov 6, 2026
Used with
Projects with it also use tailwindcss, mermaid-diagrams and 5 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
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
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
VercelSkillreact
React renderer for json-render that turns JSON specs into React components. Use when working with @json-render/react, building React UIs from JSON, creating component catalogs, or rendering AI-generated specs.
Also in 3 projects that use this
OpenAISkillwriting-skills
Use when creating new skills, editing existing skills, or verifying skills work before deployment
Also in 4 projects that use this
- +2 more from vercel-labs
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 repository24 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/hsj.mdCursor rule
- agent-evaluatorSkill
- architecture-reviewSkill
- brainstormingSkill
- build-error-resolverSkill
- code-reviewerSkill
- debuggerSkill
- git-worktree-coordinatorSkill
- implementerSkill
- prompt-injection-defenseSkill
- release-checkerSkill
- repository-explorerSkill
- requirements-clarifierSkill
- security-reviewerSkill
- subagent-driven-developmentSkill
- systematic-debuggingSkill
- tdd-workflowSkill
- technical-plannerSkill
- test-engineerSkill
- verification-loopSkill
- writing-plansSkill
The file
We split this skill into the rules it gives an agent
1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.
0
Common
Most of the 42 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Read the implementation and tests.
“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
Read the implementation and tests. Update only the relevant docs. Include prerequisites, commands, configuration, examples, and known limitations. Never document a command or behavior that was not verified or clearly marked as unverified.
Documentation test
A new reader should be able to identify what the system does, install prerequisites, run the smallest example, understand the limits, and find the next relevant document. Test commands before publishing them. Keep examples short and real.
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.

