Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →jamestorrevillas/doc-creation
Use this skill when creating technical documentation, architecture docs, runbooks, READMEs, API references, changelogs, or any structured technical writing. Trigger on keywords: documentation, docs, README, runbook, architecture doc, technical writing, write a guide, document this, API reference, changelog, how-to guide.
Passed 19 of 22 test cases with the skill, and 18 of 22 without it.
2 fixed17 passed either way2 still failing1 broke
Tokens, turns and time describe resource use, not a dollar price.
One of 2 test cases the skill fixed. Same model, same prompt, with and without the skill.
Our site reliability engineering team needs a standard operational guide for performing manual database failover during regional outages. Please draft a technical runbook in markdown covering prerequisites, step-by-step execution with exact commands, success verification, rollback procedures, and escalation contact rules.
| Checked | Without skill | With skill |
|---|---|---|
| Includes top-level metadata specifying trigger condition, required time, and authorized role | Missed | Passed |
| Formats prerequisite checklist items with empty markdown checkboxes | Missed | Passed |
| Includes an escalation condition specified by time elapsed before contacting support | Passed | Passed |
The instructions your model reads when the skill loads.
Write for the reader who is in a hurry and under stress.
Good documentation answers the question before the reader finishes asking it. Every doc should have a clear audience and a clear job to do.
| Type | Purpose | When to Write |
|---|---|---|
| README | Project overview + quickstart | Every project, day 1 |
| Architecture Doc | How the system is designed and why | Before building complex systems |
| Runbook | Step-by-step operational procedures | For anything ops needs to do repeatedly |
| API Reference | Endpoint contracts | When exposing an API to others |
| ADR | Why a significant decision was made | After every major technical decision |
| Changelog | What changed between versions | Every release |
| How-To Guide | Task-oriented instructions | When users need to do a specific thing |
# [Project Name]
One-sentence description of what this does and why it exists.
## Prerequisites
- [Dependency 1] v[X.X]
- [Dependency 2]
## Getting Started
\`\`\`bash
# Clone and install
git clone [repo]
cd [project]
test cases passed, vs 18 / 22 without
Published skills whose descriptions closely match this one, with their headline benchmark lift.
More skills from the same source and nearby in the registry, with their headline benchmark lift.