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
task.mdevals/scenario-3/
Write Reference Documentation for a Configuration File
Problem/Feature Description
A developer tool called deploykit uses a YAML configuration file (deploykit.yml) to control its behaviour. The tool has been growing quickly and now has 15+ configuration keys across three sections: server, build, and notifications. Users are constantly opening GitHub issues asking "what does X option do?" or "what's the default for Y?" — the team realises they need proper reference documentation so users can quickly look up individual settings without wading through tutorials or conceptual guides.
The documentation team has the internal spec for the configuration file and needs it turned into polished reference docs. The audience is developers who already know how to use deploykit — they just need a fast, reliable way to look up the exact name, type, default value, and effect of each configuration option when they're writing their config file.
Output Specification
Produce a Markdown file named reference.md that documents the configuration options for deploykit.yml. Because the actual tool is internal, invent realistic configuration keys that would make sense for a deployment tool. You should document at least 12 configuration options spread across the three sections (server, build, notifications).
Name the output file reference.md.