skills.rest
valtterimelkko
valtterimelkkoCOMMUNITY
Explore all skills by this author →
GitHub

code-documenter

Generate project documentation from codebase structure, git history, and dependencies.

1|1|Updated Jun 11, 2026
Search Tags:#automation#documentation#codebase#technical writing#adr#developer experience
One-click install
npx skills add https://github.com/valtterimelkko/agent-workflow-skills --skill code-documenter-valtterimelkko
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/valtterimelkko/agent-workflow-skills/tree/main/skills/code-documenter
Command: npx skills add https://github.com/valtterimelkko/agent-workflow-skills --skill code-documenter-valtterimelkko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill solves the problem of outdated, incomplete, or non-existent documentation by providing an intelligent, automated system that analyzes your codebase to generate professional-grade documentation tailored to your specific project type and audience.

Core Features & Use Cases

  • Multi-Agent Analysis: Deploys specialized agents to scan project structure, dependencies, and git history to ensure documentation is accurate and context-aware.
  • Documentation Health Tracking: Uses a manifest-based system to calculate a health score, track coverage, and identify documentation debt.
  • Use Case: When shipping a major open-source release, use this skill to generate a complete documentation suite including READMEs, API references, and Architecture Decision Records (ADRs) that stay in sync with your code.

Quick Start

Run the code-documenter skill to perform a comprehensive analysis and generate documentation for the current project.

Frequently Asked Questions about code-documenter

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

FAQPage Schema
How do I generate technical documentation for a codebase automatically?▼

Automated codebase documentation analyzes project structure, dependencies, and git history to generate professional-grade output. It deploys specialized agents to ensure documentation remains accurate, context-aware, and tailored to your specific project type.

What is documentation health tracking and how does it identify documentation debt?▼

Documentation health tracking uses a manifest-based system to calculate a health score, track coverage, and identify documentation debt. This monitoring ensures your technical docs stay in sync with the codebase and highlights areas needing updates.

Can I generate architecture decision records and API references for an open-source release?▼

Yes, you can generate architecture decision records (ADRs) and API references for major releases. The system analyzes your codebase to create a complete documentation suite that stays synchronized with your current code.

Does the documentation generator support incremental updates for existing projects?▼

Yes, the documentation generator supports incremental updates for existing projects. This allows you to refresh only the outdated sections of your documentation instead of regenerating the entire suite from scratch.

Can I create multi-audience output for APIs, CLIs, and libraries?▼

Yes, you can create multi-audience output for APIs, CLIs, and libraries. The system generates reader-first documentation tailored to different audience needs while maintaining standardized templates across the project.

What is the best way to maintain standardized documentation templates across a software project?▼

The best way to maintain standardized templates is through automated generation that analyzes your codebase and dependencies. This ensures consistent formatting and coverage reporting across all technical documentation outputs.

Related Skills

Explore More Software Engineering Skills→
tsuna44tsuna44

xddp.fill-rulebook

Generate project-rulebook documentation from repository structure and git history.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
manastalukdarmanastalukdar
1

canary

Poll logs, error rates, and endpoints to verify post-deployment health.

Community
Advanced
phuhao00phuhao00
12

code-analyst-agent

Analyze source code to identify symbols, call graphs, and architectural patterns.

Community
Intermediate