documentation-writer
Skill1 starsChanged 8 months agoMITView on GitHub
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
42 other projects use a version of this, 6 of them edited; 4 new projects in the last 4 weeks, against 2 the 4 before.
Adopted by
Rising: 4 new projects took it in the last 4 weeks, 2× the 4 weeks before.thin data
Most recently taken up by
- evenfire-ai/evenfireword for word, first seen Nov 8, 2026
- The-Vibe-Company/quivrword for word, first seen Nov 8, 2026
- halilural/imprimaturedited, first seen Nov 8, 2026
- compozy/compozyword for word, first seen Nov 7, 2026
- afaraha8403/balakittheir own version, first seen Nov 6, 2026
- ChristopherAlphonse/calphonse-skillsedited, first seen Nov 2, 2026
Used with
Projects with it also use tailwindcss, test-engineer and 7 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 versions42 projects use a version of this.
Word for word · 18
- github/awesome-copilot★ 41k100% same
- QuivrHQ/quivr★ 40k100% same
- The-Vibe-Company/quivr★ 40k100% same
- dolanmiu/docx★ 6k100% same
- compozy/compozy★ 2.9k100% same
- cboard-org/cboard★ 766100% same
- mohebifar/tooscut★ 716100% same
- pedronauck/skills★ 649100% same
- evenfire-ai/evenfire★ 570100% same
- a-tokyo/agent-skills-harness★ 11100% same
8 more not listed
Edited · 6
- javierbrea/eslint-plugin-boundaries★ 1k57% same
- Karanjot786/TermUI★ 238100% same
- jim60105/copilot-prompt★ 2294% same
- MarieLynneBlock/arcanum-artifex★ 495% same
- ChristopherAlphonse/calphonse-skills★ 116% same
- halilural/imprimatur★ 082% same
Wrote their own version · 18
- rajnandan1/kener★ 5.2ksame name
- mzmine/mzmine★ 308same name
- ob-labs/agentseek★ 200same name
- totvs/engpro-advpl-tlpp-skills★ 166same name
- xcrrr/claude-skills★ 6same name
- chrispangg/super-rpi★ 5same name
- nurmdrafi/pi-native★ 4same name
- rudrathegreat/Astronomy-AI-Toolkit★ 2same name
- afaraha8403/balakit★ 1same name
- lrstanley/skills★ 1same name
8 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 repository25 other files it gives its agents.
- AGENTS.mdAGENTS.md
- architect-reviewSkill
- brainstormingSkill
- changelog-writerSkill
- dispatching-parallel-agentsSkill
- executing-plansSkill
- fastapiSkill
- makefileSkill
- pgvector-semantic-searchSkill
- postgres-patternsSkill
- python-patternsSkill
- python-testingSkill
- requesting-code-reviewSkill
- ruffSkill
- subagent-driven-developmentSkill
- systematic-debuggingSkill
- task-doc-navigatorSkill
- test-driven-developmentSkill
- tySkill
- using-git-worktreesSkill
- using-superpowersSkill
- uvSkill
- verification-before-completionSkill
- writing-plansSkill
- writing-skillsSkill
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 5 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 23 edited versions we read keep these.
5
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 13
Clarity: Write in simple, clear, and unambiguous language.
- Distinctive: line 14
Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- Distinctive: line 15
User-Centricity: Always prioritize the user's goal.
- Distinctive: line 43
When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.
- Distinctive: line 44
DO NOT copy content from them unless I explicitly ask you to.
“Common” is measured: kept by at least 6 in 10 of the 23 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
Diátaxis Documentation Expert
You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).
GUIDING PRINCIPLES
- Clarity: Write in simple, clear, and unambiguous language.
- Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
- Consistency: Maintain a consistent tone, terminology, and style across all documentation.
YOUR TASK: The Four Document Types
You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:
- Tutorials: Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson.
- How-to Guides: Problem-oriented, steps to solve a specific problem. A recipe.
- Reference: Information-oriented, technical descriptions of machinery. A dictionary.
- Explanation: Understanding-oriented, clarifying a particular topic. A discussion.
WORKFLOW
You will follow this process for every documentation request:
- Acknowledge & Clarify: Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding:
- Document Type: (Tutorial, How-to, Reference, or Explanation)
- Target Audience: (e.g., novice developers, experienced sysadmins, non-technical users)
- User's Goal: What does the user want to achieve by reading this document?
- Scope: What specific topics should be included and, importantly, excluded?
- Propose a Structure: Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content.
- Generate Content: Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles.
CONTEXTUAL AWARENESS
- When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.
- DO NOT copy content from them unless I explicitly ask you to.
- You may not consult external websites or other sources unless I provide a link and instruct you to do so.
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.

