Writing Documentation With Diataxis
This helps Claude write technical documentation using the Diataxis framework, which organizes docs into four types based on what users actually need: tutorials for learning by doing, how-to guides for accomplishing specific tasks, reference material for looking up facts, and explanations for understanding concepts. The approach is refreshingly anti-template. Instead of forcing you to fill out all four sections, it encourages creating what serves real user needs and letting structure emerge naturally. Built by sammcj with 136 stars and 475 installs. If you've ever stared at a blank docs page wondering whether to write a tutorial or a guide, this gives you a practical mental model for deciding what to create and how to structure it.
- install copies · 90 days. Times the install command was copied on this site in the last 90 days, bots filtered.
- 5
- skills.sh installs
- 627
- GitHub stars
- 169
- last updated
- Aug 21, 2026
Install
$ npx -y skills add sammcj/agentic-coding --skill writing-documentation-with-diataxis --agent claude-codeInstalls into .claude/skills of the current project.
Files
Writing Documentation with Diataxis
You help users create and improve technical documentation using the Diataxis framework, which identifies four distinct documentation types based on user needs.
What Diataxis Is
Diataxis is a framework for creating documentation that feels good to use - documentation that has flow, anticipates needs, and fits how humans actually interact with a craft.
Important: Diataxis is an approach, not a template. Don't create empty sections for tutorials/how-to/reference/explanation just to have them. Create content that serves actual user needs, apply these principles, and let structure emerge organically.
Core insight: Documentation serves practitioners in a domain of skill. What they need changes based on two dimensions:
- Action vs Cognition - doing things vs understanding things
- Acquisition vs Application - learning vs working
These create exactly four documentation types:
- Learning by doing → Tutorials
- Working to achieve a goal → How-to Guides
- Working and need facts → Reference
- Learning to understand → Explanation
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/sammcj/agentic-coding
- Categories
- Documentation, Code Review & Quality, AI & Agent Building
- First seen
- Jun 3, 2026
More from sammcj/agentic-coding
All 4Recommended
More Documentation
doc-writinghuangjia2019/claude-code-engineeringGenerate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.0skills.sh installs
docs-writer-learnreactjs/react.devIf you're contributing to React documentation or building similar technical learning content, this skill knows the patterns cold.0skills.sh installs
docs-demoremotion-dev/remotionAdd an interactive demo to the Remotion documentation. Use when creating a new <Demo> component for docs pages.0skills.sh installswriting-docsremotion-dev/remotionGuides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.0skills.sh installsdocs-demoremotion-dev/remotionAdd an interactive demo to the Remotion documentation. Use when creating a new <Demo> component for docs pages.2.6Kskills.sh installs
technical-writingmindrally/skillsExpert technical writing guidelines for creating clear, in-depth developer tutorials and documentation with practical, implementable knowledge1.2Kskills.sh installs