doc

Review and generate code documentation against defined principles and templates.

1|Updated Jan 18, 2026
One-click install
npx skills add https://github.com/nielsmadan/agentic-coding --skill doc-nielsmadan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc
Source: https://github.com/nielsmadan/agentic-coding/tree/main/claude/skills/doc
Command: npx skills add https://github.com/nielsmadan/agentic-coding --skill doc-nielsmadan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of reviewing and generating high-quality documentation, ensuring consistency, accuracy, and adherence to best practices across your projects.

Core Features & Use Cases

  • Documentation Review: Automatically checks existing documentation against a defined set of principles (e.g., no local paths, clear examples, single source of truth).
  • Documentation Generation: Creates new documentation for code or features based on project standards.
  • Use Case: Before committing code, run /doc --review --staged to catch any documentation errors or omissions in your changes, ensuring your codebase remains well-documented.

Quick Start

Review the documentation for staged code changes.

Frequently Asked Questions about doc

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

FAQPage Schema
How do I review documentation for staged files before committing code?

You can review documentation for staged files by running an automated check against defined principles like clear examples and single source of truth. This catches errors and omissions in your code changes before committing, ensuring your codebase remains well-documented.

How do I check if existing documentation meets quality standards?

To check if existing documentation meets quality standards, run an automated review against a defined set of principles. It validates accuracy, quality, and completeness by detecting issues like local paths or missing examples across all project files.

Can I generate markdown documentation for specific code features automatically?

Yes, you can generate markdown documentation for specific code features automatically. The generation process creates new documents following specific templates for modules and features, operating on context-based documents or all project files.

What are the best practices for maintaining consistent codebase documentation?

Best practices for maintaining consistent codebase documentation involve automated checks for accuracy and completeness. Establishing a single source of truth, avoiding local paths, and providing clear examples ensures your project documentation adheres to defined standards.

Does documentation generation work without external dependencies?

Yes, documentation generation and review work without external dependencies. The tool operates independently on staged files, all project files, or context-based documents to evaluate and create markdown documentation based on your defined principles.