Guidance for structuring Ark documentation using the Diataxis framework. Use this skill when creating new docs, deciding where content belongs, reviewing documentation PRs, or restructuring existing documentation.
74
62%
Does it follow best practices?
Impact
93%
1.17xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./.claude/skills/documentation/SKILL.mdQuality
Discovery
75%Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.
This is a solid description that clearly communicates its purpose and when to use it. Its main weakness is that the specific actions could be more concrete—listing what the skill actually does beyond 'guidance for structuring' (e.g., classifying content into Diataxis categories, generating doc templates). The trigger terms could also be expanded to include Diataxis-specific vocabulary users might use.
Suggestions
Add more concrete actions beyond 'guidance for structuring', such as 'classifies content into tutorials, how-to guides, reference, and explanation categories' or 'generates documentation templates following Diataxis patterns'.
Include Diataxis-specific trigger terms users might naturally say, such as 'tutorial', 'how-to guide', 'reference doc', 'explanation page', or 'where should this content go'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description names the domain (Ark documentation, Diataxis framework) and mentions some actions (creating docs, deciding content placement, reviewing PRs, restructuring), but these are fairly general activities rather than concrete specific actions like 'generate tutorial templates' or 'classify content into Diataxis categories'. | 2 / 3 |
Completeness | The description clearly answers both 'what' (structuring Ark documentation using Diataxis framework) and 'when' with an explicit 'Use this skill when...' clause listing four specific trigger scenarios: creating new docs, deciding content placement, reviewing documentation PRs, and restructuring existing documentation. | 3 / 3 |
Trigger Term Quality | Includes some relevant keywords like 'documentation', 'docs', 'PRs', 'Diataxis', and 'Ark', but misses common variations users might say such as 'how-to guide', 'tutorial', 'reference page', 'explanation', 'doc structure', or 'where should this doc go'. The term 'Diataxis' is somewhat niche and may not be what users naturally type. | 2 / 3 |
Distinctiveness Conflict Risk | The combination of 'Ark' (specific project), 'Diataxis framework' (specific methodology), and 'documentation' creates a clear niche that is unlikely to conflict with other skills. The triggers are well-scoped to documentation structure decisions rather than general writing or coding. | 3 / 3 |
Total | 10 / 12 Passed |
Implementation
50%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This is a solid documentation framework guide that clearly explains the Diataxis structure adapted for ARK, with useful decision aids like the classification flowchart and persona mapping. Its main weaknesses are the lack of concrete worked examples (e.g., sample doc snippets showing correct classification), missing explicit workflows for the stated use cases (PR review, restructuring), and a monolithic structure that could benefit from splitting detailed sections into referenced files.
Suggestions
Add concrete before/after examples showing a piece of documentation being correctly classified or restructured (e.g., 'This paragraph is explanation mixed into a how-to guide—move it to Core Concepts').
Add explicit step-by-step workflows for the key use cases: a PR review checklist for documentation, a process for restructuring existing docs with validation steps.
Split the writing guidelines and detailed quadrant descriptions into separate referenced files, keeping SKILL.md as a concise overview with clear pointers to detailed guidance.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is generally well-structured and avoids excessive verbosity, but includes some redundancy (e.g., 'When to use this skill' repeats the description, and some sections like the four quadrants could be tighter). The writing guidelines section is thorough but could be more condensed since much of it is standard style guide material Claude already knows. | 2 / 3 |
Actionability | The skill provides concrete decision frameworks (the decision guide flowchart, 'Content belongs here if' checklists, persona mapping table) which are actionable for documentation classification. However, it lacks executable examples—no sample markdown snippets showing a correctly structured tutorial vs. how-to guide, no template files, and no concrete before/after examples of documentation being categorized or restructured. | 2 / 3 |
Workflow Clarity | The decision guide provides a clear decision tree for classifying content, and the 'Content belongs here if' sections serve as useful checkpoints. However, for the stated use cases (creating new docs, reviewing PRs, restructuring), there are no explicit step-by-step workflows with validation steps—e.g., no checklist for reviewing a PR to ensure content isn't mixed across quadrants, no process for restructuring existing docs. | 2 / 3 |
Progressive Disclosure | The content is well-organized with clear sections and tables, but it's a fairly long monolithic document (~180 lines) with no references to supporting files. The writing guidelines section and the detailed quadrant descriptions could be split into separate referenced files, keeping the SKILL.md as a concise overview with pointers. | 2 / 3 |
Total | 8 / 12 Passed |
Validation
100%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 11 / 11 Passed
Validation for skill structure
No warnings or errors.
6b7c761
Table of Contents
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.