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-4/
Write a Beginner Tutorial for a Command-Line Tool
Problem/Feature Description
A small open-source project called textcount has just published a Python command-line tool that counts words, lines, and characters in text files. The maintainers have had great feedback from developers who use it daily, but they keep getting GitHub issues from complete beginners who can't figure out how to get started. The README only covers installation flags and options — it assumes users already know how to use the terminal and install Python packages.
The maintainers want a proper getting-started document aimed at someone who has Python installed but has never used a CLI tool before. The document should walk a new user through running textcount for the first time, from installing it to seeing their first results, with nothing assumed beyond having Python 3 available. It should build confidence through small, achievable steps rather than overwhelming the reader with all the features at once.
Output Specification
Produce a single Markdown file named tutorial.md that a beginner can follow to install textcount and successfully analyse their first text file. The document should be self-contained and end with the user having achieved something real and visible. Because textcount is fictional, invent realistic command syntax and output that looks plausible (e.g., pip install textcount, textcount hello.txt).
The document should cover:
- Installing the tool
- Creating a simple sample file to analyse
- Running the tool and understanding the output
- At least one extension step (e.g., analysing multiple files)
Name the output file tutorial.md.