code-document

Adds grounded comments and docstrings to undocumented Go, Python, Helm, Dockerfile, shell, and workflow code.

2|Updated Apr 5, 2026
One-click install
npx skills add https://github.com/witwave-ai/witwave --skill code-document-witwave-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-document
Source: https://github.com/witwave-ai/witwave/tree/main/.agents/self/nova/.claude/skills/code-document
Command: npx skills add https://github.com/witwave-ai/witwave --skill code-document-witwave-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Exported symbols, chart values, and build instructions often ship without documentation, forcing future contributors and AI agents to reverse-engineer intent from code. This Skill fills those gaps with comments that are strictly grounded in what the code demonstrably does, and logs anything it cannot truthfully describe for human review. ## Core Features & Use Cases - Multi-language documentation authoring: Adds godoc comments to Go exports, docstrings to public Python functions, helm-docs-style comments to values.yaml entries, and explanatory comments to Dockerfile instructions, shell functions, and GitHub Actions workflow steps. - Groundedness discipline: Every comment must be derivable from reading the code body; symbols that resist truthful description are skipped and logged to deferred-findings memory instead of receiving speculative filler. - Bounded, reviewable batches: Caps each run at 25 candidates, prioritizes high-visibility surfaces, and produces one commit per category so reviewers can revert any batch independently. - Use Case: After a refactor introduces new exported symbols in an operator package, run this Skill to document the undocumented exports, commit the godoc additions separately from any Helm value comments, and delegate the push to a peer agent. ## Quick Start Ask the agent to document the missing docstrings and code comments in the current checkout, keeping each category in its own commit.

Frequently Asked Questions about code-document

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

FAQPage Schema
How do I add missing docstrings and comments to a codebase automatically?▼

Run this Skill against a clean git checkout; it scans for undocumented Go exports, Python public functions, Helm values, Dockerfile instructions, shell functions, and workflow steps, then writes grounded comments and commits each category separately.

What file types does automated code documentation cover?▼

It covers six categories: Go exported symbols (godoc), Python public functions (docstrings), Helm values.yaml entries (helm-docs style), non-obvious Dockerfile instructions, shell script functions, and GitHub Actions workflow steps.

Does it document symbols it cannot understand from the code?▼

No. Symbols whose behavior cannot be truthfully described from reading the body are skipped and logged to deferred-findings memory with a one-line reason for human review, rather than receiving speculative comments.

How many documentation candidates are processed per run?▼

At most 25 candidates across all categories per invocation. Larger queues are prioritized by visibility, starting with Go exports in operator and CLI code, then Helm values, Python functions, Dockerfiles, workflows, and shell scripts.

Can it rewrite or remove existing code comments?▼

No. The Skill only adds documentation where it is missing. Rewriting or removing existing comments is explicitly out of scope and belongs to a separate verification workflow.