Writing effective code documentation - API docs, README files, inline comments, and technical guides.
SkillScore82Maintained
Automatic
◆Doc Ops pack
Last verified 8/16/2026
What it changes
Passed 18 of 22 test cases with the skill, and 13 of 22 without it.
Without skill59%
With skill82%
Checks it passed that the model alone missed
Explains progressive disclosure as the justification.
Includes `@default 20` inside the `maxPoolSize` comment line.
Omits curly bracket type annotations inside `@param` JSDoc tags.
and 5 more in the full report
7 fixed11 passed either way2 still failing2 broke
Pass-rate lift
+23 pp
Tokens
+53%
Agent turns
0%
Response time
-21%
Model gemini-3.6-flashMeasured 8/16/2026v118 of 22 cases passed with skill
Tokens, turns and time describe resource use, not a dollar price.
See it in action
One of 7 test cases the skill fixed. Same model, same prompt, with and without the skill.
1 of 7
Prompt
I am defining a TypeScript interface `DatabaseClientConfig` that contains `connectionString: string`, optional `maxPoolSize?: number` (defaults to 20), and optional `sslOptions?: SSLOptions`. Can you draft the TSDoc / JSDoc comments for this interface definition?
What was checked, without and with the skill
Checked
Without skill
With skill
Includes `@default 20` inside the `maxPoolSize` comment line.
Missed
Passed
Omits type brackets inside property JSDoc comments.
Passed
Passed
case-07 · gemini-3.6-flash · 8/16/2026 · answers are capped and redacted
What's inside
The instructions your model reads when the skill loads.
SKILL.md256 linessingle file
Code Documentation
README Structure
Standard README Template
# Project Name
Brief description of what this project does.
## Quick Start
\`\`\`bash
npm install
npm run dev
\`\`\`
## Installation
Detailed installation instructions...
## Usage
\`\`\`typescript
import { something } from 'project';
// Example usage
const result = something.doThing();
\`\`\`
## API Reference
### `functionName(param: Type): ReturnType`
Description of what the function does.
**Parameters:**
- `param` - Description of parameter
**Returns:** Description of return value