repo-documenter

Inspect repositories with MCP tools and update architecture and API documentation.

1|Updated Dec 4, 2025

Search Tags:#architecture #templates #documentation #mermaid #docs

Ready to run

npx skills add https://github.com/timbuchinger/loadout --skill repo-documenter

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: repo-documenter
Source: https://github.com/timbuchinger/loadout/tree/main/skills/repo-documenter
Command: npx skills add https://github.com/timbuchinger/loadout --skill repo-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides repository-level documentation guidelines, keeps README and docs in sync with the current reality, and uses tool-based inspection before making changes.

Core Features & Use Cases

Documentation governance: Define where docs live (docs/ and architecture indices).
Tool-first approach: Inspect code and configs before writing docs.
Mermaid diagrams: Use diagrams to clarify architecture.
Templates: Leverages templates to structure docs.

Quick Start

Inspect the repository with the intended tooling, then create or update docs under docs/ to reflect the current state.

Frequently Asked Questions about repo-documenter

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

FAQPage Schema

How do I keep my repository documentation in sync with code changes?▼

Repository-wide documentation governance ensures docs stay current by using tool-based inspection of code and configs before updating architecture docs, README, and diagrams under docs/ to reflect the present system state.

What's the best way to document software architecture with diagrams?▼

Architecture documentation uses Mermaid diagrams to clarify system design, combined with structured templates for consistency. Mandatory architecture entry points under docs/architecture enforce clear, visual representation of your codebase.

How do I set up consistent documentation standards across a project?▼

Define documentation guidelines under docs/ with lowercase-dashed filenames and architecture indices. Use provided templates for index and architecture docs to enforce consistency across README, APIs, and usage documentation.

Can I automate documentation updates when my code changes?▼

Tool-first inspection with MCP tools examines existing docs and code to determine which files need updates. This approach creates or modifies only necessary documentation to keep architecture, APIs, and usage guides aligned with current reality.

Does this work with existing MCP tools in my repository?▼

Yes, the Skill applies tool-based inspection first using MCP tools if configured in your repository, then intelligently creates or updates documentation based on what it discovers across your codebase and existing docs.