This skill should be used when writing documentation for codebases, including README files, architecture documentation, code comments, and API documentation.
SkillScore43Maintained
Automatic
◆Doc Ops pack
Last verified 8/19/2026
What it changes
Passed 10 of 23 test cases with the skill, and 3 of 23 without it.
Without skill13%
With skill43%
Checks it passed that the model alone missed
The documentation defines technical jargon terms for beginner readers.
The document starts with a top-level heading titled `# Architecture Overview`.
The comment appears prior to the conditional block to explain why the check exists.
and 6 more in the full report
7 fixed3 passed either way13 still failing0 broke
Pass-rate lift
+30 pp
Tokens
+114%
Agent turns
0%
Response time
-5%
Model gemini-3.6-flashMeasured 8/19/2026v110 of 23 cases passed with skill
Tokens, turns and time describe resource use, not a dollar price.
What's inside
The instructions your model reads when the skill loads.
SKILL.md340 lines3 files
Codebase Documenter
Overview
This skill enables creating comprehensive, beginner-friendly documentation for codebases. It provides structured templates and best practices for writing READMEs, architecture guides, code comments, and API documentation that help new users quickly understand and contribute to projects.
Core Principles for Beginner-Friendly Documentation
When documenting code for new users, follow these fundamental principles:
Start with the "Why" - Explain the purpose before diving into implementation details
Use Progressive Disclosure - Present information in layers from simple to complex
Provide Context - Explain not just what the code does, but why it exists
Include Examples - Show concrete usage examples for every concept
Assume No Prior Knowledge - Define terms and avoid jargon when possible
Visual Aids - Use diagrams, flowcharts, and file tree structures
Quick Wins - Help users get something running within 5 minutes
Documentation Types and When to Use Them
1. README Documentation
When to create: For project root directories, major feature modules, or standalone components.
Structure to follow:
# Project Name
## What This Does
[1-2 sentence plain-English explanation]
## Quick Start
[Get users running the project in < 5 minutes]
## Project Structure
[Visual file tree with explanations]
## Key Concepts
[Core concepts users need to understand]