docs

Update software documentation and code comments to match current code behavior.

2|Updated Jul 11, 2026
One-click install
npx skills add https://github.com/nmnmcc/skills --skill docs-nmnmcc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/nmnmcc/skills/tree/main/skills/docs
Command: npx skills add https://github.com/nmnmcc/skills --skill docs-nmnmcc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps keep software documentation and code comments aligned with the real system so readers can understand, use, change, or operate it without being misled by stale or vague prose.

Core Features & Use Cases

  • Documentation planning: Decide what to document, who the reader is, and where the truth should live.
  • Doc and comment maintenance: Write or update README files, guides, runbooks, docstrings, and inline comments when behavior changes.
  • Contract-aware writing: Describe APIs, commands, settings, and operating paths in terms of what users can rely on, then verify claims against source code and checks.
  • Use case: A developer changes a public API and needs the README, docstring, and example commands updated to match the new behavior and validation rules.

Quick Start

Ask the docs skill to review the changed code and update the nearest README or docstring so it matches the current behavior.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I keep documentation updated when code changes?

To keep README files accurate after API changes, trace documentation claims back to the owning source code and tests. Remove stale explanations, update example commands, and verify new validation rules against the actual implementation.

What is the best way to maintain API contracts in documentation?

Maintaining API contracts in documentation requires describing endpoints in terms of what users can rely on, then verifying those claims against source code. Remove unsupported explanations and update reference docs when behavior changes.

How do I update docstrings and inline comments to match implementation?

Update docstrings and inline comments by tracing them back to the authoritative source code and tests. Rewrite any vague guidance to match current validation rules, operating behavior, and implementation paths.

When should I update runbooks and migration notes?

Update runbooks and migration notes whenever implementation changes alter operating behavior or setup paths. Verify all documented commands and steps against authoritative sources to remove stale or unsupported explanations.

Does this documentation approach work for tutorials and setup guides?

Yes, this approach works for tutorials and setup guides by tracing procedural claims back to owning code and commands. It removes stale explanations and ensures readers follow accurate, verified operating paths.