document

Analyze code to generate rationale-focused documentation explaining non-obvious decisions.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/mickaelyoshua/dev --skill document-mickaelyoshua
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/mickaelyoshua/dev/tree/main/.claude-skills/document
Command: npx skills add https://github.com/mickaelyoshua/dev --skill document-mickaelyoshua

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes code and adds purposeful documentation that explains why decisions were made, avoiding unnecessary boilerplate.

Core Features & Use Cases

  • Identify non-obvious business decisions behind code and explain them in plain language.
  • Retain useful inline comments and remove noise to improve readability.
  • Generate documentation maps for onboarding new contributors and for maintenance reviews.

Quick Start

Analyze the target codebase and add concise, rationale-focused documentation and comments.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add code documentation that explains why decisions were made?

To add code documentation explaining decisions, analyze the codebase to identify non-obvious business logic and generate concise, rationale-focused comments that clarify intent while preserving existing structure.

What is the best way to generate code comments for onboarding new developers?

Generating code comments for onboarding involves creating documentation maps that explain non-obvious logic in plain language, reducing cognitive load for new contributors by focusing on why the code exists rather than what it does.

How do I clean up code comments and remove noise during maintenance?

To clean up code comments and remove noise, analyze the code to retain useful inline notes that document implicit contracts, while stripping redundant boilerplate that simply restates what the code already shows.

Can I document implicit contracts in my code without adding unnecessary boilerplate?

Yes, you can document implicit contracts without boilerplate by analyzing code to add purposeful documentation only where non-obvious decisions exist, respecting the existing structure rather than overwriting it with redundant explanations.

Does this approach to code clarity work for existing codebases during code reviews?

Yes, this code clarity approach works during code reviews and maintenance by analyzing existing code to improve readability, identifying non-obvious logic, and removing noise while preserving useful comments already present.

When should I avoid adding inline comments to my code?

You should avoid adding inline comments when the code is already obvious, as the goal is to remove noise and reduce cognitive load rather than generate boilerplate that simply restates what the code does.