documentation

Audits code files and adds docstrings, inline comments, and section headers.

Updated Jul 29, 2026
One-click install
npx skills add https://github.com/chris-prener/dev-kit --skill documentation-chris-prener
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/chris-prener/dev-kit/tree/main/dev-kit/skills/documentation
Command: npx skills add https://github.com/chris-prener/dev-kit --skill documentation-chris-prener

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Codebases accumulate undocumented functions, missing docstrings, and stale comments that slow down onboarding and maintenance. This Skill runs a systematic, language-agnostic documentation audit that inventories every file, fills documentation gaps without changing code behavior, and produces a timestamped report. ## Core Features & Use Cases - Tiered Documentation Audit: Classifies files into four tiers (function libraries, script-embedded functions, pipeline scripts, configuration) and applies the right documentation strategy to each. - Gap Filling with Validation: Writes complete docstrings for every Tier 1/2 function, adds why-focused inline comments and section headers, then parse-checks every modified file. - Reporting and Issue Filing: Generates a timestamped report in docs/doc-reports/ and auto-files durable backlog issues for findings like missing or stale docstrings. - Use Case: Point it at a legacy module and ask it to audit documentation — it inventories all functions, adds missing docstrings in the project's existing style, fixes stale parameter docs, and files issues for anything it cannot fix in place. ## Quick Start Ask the assistant to audit the documentation in the src directory and add docstrings to any undocumented functions.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I add docstrings to undocumented functions in a repository?▼

Run a documentation audit that inventories every function, classifies files by tier, and writes complete docstrings covering description, parameters, and return values. The audit matches the project's existing docstring convention rather than imposing a new one.

How to audit code documentation coverage across a project?▼

A documentation audit scans each file for docstring status, inline-comment density, and section headers, then builds a prioritized work queue. It produces a timestamped report listing complete, partial, and missing documentation per file.

Does this documentation audit work with languages other than R?▼

Yes, the audit process is language-agnostic and follows each ecosystem's standard convention, such as PEP 257 with type hints for Python. R-specific roxygen2 tag conventions are delegated to the separate r-documentation skill.

Will adding documentation change my code behavior?▼

No, the audit never changes code logic and validates that every modified file still parses after edits. Bugs discovered during documentation are recorded in the report instead of being fixed in place.

When should I not use a full documentation audit?▼

Skip it for PR-scoped stale-doc checks, which belong to documentation-audit-changes, and for multi-artifact runs spanning README and walkthrough files, which belong to documentation-suite. Prose documents like READMEs are handled by separate skills.