Add skill definition to guide AI coding agents with Diataxis principles#162
Open
ertembiyik wants to merge 1 commit intoevildmp:mainfrom
Open
Add skill definition to guide AI coding agents with Diataxis principles#162ertembiyik wants to merge 1 commit intoevildmp:mainfrom
ertembiyik wants to merge 1 commit intoevildmp:mainfrom
Conversation
Create a Claude skill that helps agents write, review, and structure documentation using the Diataxis methodology. The skill uses a compressed index in SKILL.md paired with symlinked reference files from the framework repo, following the Vercel research pattern where passive context outperforms active retrieval. Includes the four documentation types (tutorials, how-to guides, reference, explanation) and the compass classification tool. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AI coding agents increasingly write and maintain documentation, but they default to unstructured output that mixes tutorials, reference, and explanation. This PR adds a skill definition that teaches agents to apply Diataxis principles when writing docs.
The skill uses a compressed index (SKILL.md) with the core framework: the 2x2 matrix, compass, quick rules per type, common mistakes, plus symlinked references back to the repo’s .rst files. Content changes to existing files are reflected automatically via symlinks. Adding or removing .rst files requires updating the symlinks and index accordingly.
What’s added:
No existing files are modified.