documentation-engineer

Audit technical documentation against live codebases and propose patches.

Updated May 7, 2026
One-click install
npx skills add https://github.com/tmalcolm-0607/mad-council-claw --skill documentation-engineer-tmalcolm-0607
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-engineer
Source: https://github.com/tmalcolm-0607/mad-council-claw/tree/main/.claude/skills/documentation-engineer
Command: npx skills add https://github.com/tmalcolm-0607/mad-council-claw --skill documentation-engineer-tmalcolm-0607

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the burden of outdated, incomplete, or missing technical documentation that slows down development, hinders team onboarding, and creates inconsistencies between code and its accompanying guides.

Core Features & Use Cases

  • Documentation Auditing: Scans existing docs for stale references, broken links, and misalignment with the current codebase, proposing targeted patches for fixes.
  • Multi-format Doc Generation: Creates API documentation, README files, architecture guides, code comments (JSDoc, docstrings, etc.), changelog entries, and migration guides tailored to the project's tech stack.
  • Consistency Enforcement: Applies project-specific documentation standards and best practices, including anti-hallucination protocols that verify all code references against source files before inclusion.
  • Use Case: For a fast-moving TypeScript project with 60+ exported APIs, use this skill to automatically generate JSDoc comments for all undocumented public functions, update the README to reflect new CLI flags, and flag any architecture docs that reference deprecated services.

Quick Start

Use the documentation-engineer skill to audit all project documentation for accuracy against the current codebase and propose prioritized patches for any stale or missing content.

Frequently Asked Questions about documentation-engineer

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

FAQPage Schema
How do I automatically generate technical documentation for APIs in a TypeScript project?

To generate technical documentation for APIs in a TypeScript project, you can use automation tools to create JSDoc comments for all undocumented public functions and update README files to reflect new CLI flags, ensuring your project docs remain accurate and aligned with the codebase.

What is the best way to audit existing technical documentation against a live codebase?

The best way to audit technical documentation against a live codebase is to scan existing docs for stale references, broken links, and misalignment with current code, which allows you to flag outdated architecture guides and propose targeted patches for any missing or inaccurate content.

Can I use automated documentation generation across multiple programming languages like Python and Go?

Yes, automated documentation generation supports multiple programming languages including Python, Go, Java, and C#. It applies language-specific documentation format compliance to ensure API docs, code comments, and changelog entries match the conventions of each respective tech stack.

How do you prevent hallucinated code references when generating API documentation?

To prevent hallucinated code references when generating API documentation, you should enforce anti-hallucination protocols that verify all code references against actual source files before inclusion, ensuring consistency and eliminating inaccurate or outdated technical guides.

Does automated documentation maintenance work for large projects with many exported APIs?

Automated documentation maintenance works effectively for large projects by scanning undocumented public functions and generating compliant docstrings or JSDoc comments across all 60+ exported APIs, ensuring comprehensive coverage without manual overhead.