mcollina/documentation
Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API documentation, create explanation pages, choose between Diátaxis documentation types, or improve existing documentation structure. Trigger terms include: documentation structure, Diátaxis, tutorials vs how-to guides, organize docs, user guide, reference docs, technical writing.
91
87%
Does it follow best practices?
Impact
96%
1.11xAverage score across 5 eval scenarios
Passed
No known issues
Evaluation results
100%
3%Write a Conceptual Overview of Database Indexing
Concept-framed title
100%
100%
Context section present
100%
100%
Core concept explained
100%
100%
Trade-offs covered
100%
100%
Alternatives discussed
100%
100%
Higher-level perspective
100%
100%
No step-by-step instructions
70%
100%
No technical spec mixing
100%
100%
Rationale emphasis
100%
100%
No how-to framing
100%
100%
92%
28%Write a Guide for Connecting a Node.js App to Redis
Task-framed title
10%
100%
Goal statement
0%
100%
Assumptions/prerequisites listed
20%
100%
Numbered steps
100%
100%
Expected result stated
90%
100%
Assumes baseline knowledge
100%
100%
No conceptual digressions
100%
100%
Alternatives noted
25%
33%
No tutorial pattern mixing
100%
100%
No reference table mixing
100%
100%
Experienced-user appropriate
87%
100%
93%
-3%Write Reference Documentation for a Configuration File
Noun-based title
100%
100%
Name field per entry
100%
100%
Type field per entry
100%
100%
Default value per entry
100%
100%
Description per entry
100%
100%
Example per entry
70%
70%
Consistent format
100%
100%
Facts not instructions
100%
70%
No step-by-step mixing
100%
100%
No conceptual mixing
100%
100%
Entries independently scannable
87%
87%
94%
31%Write a Beginner Tutorial for a Command-Line Tool
Verb-led title
0%
100%
Goal statement present
30%
100%
Prerequisites section
25%
100%
Numbered steps
100%
100%
Verifiable result per step
100%
100%
Final outcome stated
100%
100%
Minimises explanation
50%
70%
Maximises doing
70%
90%
Beginner self-sufficiency
50%
75%
No reference table mixing
100%
100%
No conceptual digressions
75%
100%
72%
-6%Reorganise Documentation for a Developer Tool
Tutorial separated
87%
100%
How-to separated
100%
100%
Reference separated
50%
75%
Explanation separated
100%
100%
Each file is a single type
66%
66%
Cross-links present
0%
100%
Consistent 'workspace' terminology
75%
62%
Consistent 'sync job' terminology
87%
25%
Tutorial heading pattern
100%
0%
How-to heading pattern
100%
50%
Reference heading pattern
100%
87%
Index file produced
100%
100%