repo-documenter

Generate verified repository documentation with a four-phase workflow.

3|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/chris-c-thomas/OxideSEO --skill repo-documenter-chris-c-thomas
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-documenter
Source: https://github.com/chris-c-thomas/OxideSEO/tree/main/.claude/skills/repo-documenter
Command: npx skills add https://github.com/chris-c-thomas/OxideSEO --skill repo-documenter-chris-c-thomas

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Repo Documenter creates a comprehensive, verified documentation set for an existing repository, ensuring every factual claim can be traced to real files, commands, or artifacts.

Core Features & Use Cases

  • Four-phase workflow (Discovery → Architecture → Synthesis → Verification) that guards against hallucinations and drift.
  • Produces standard project docs (ARCHITECTURE.md, DEVELOPMENT.md, CONTRIBUTING.md, DEPLOYMENT.md, ADRs) plus a root README with navigation and links.
  • Handles verification tasks by tying outputs to the codebase and surfacing open questions for user confirmation.

Quick Start

Provide the repository path and run this skill to generate a complete, verified repository documentation set.

Frequently Asked Questions about repo-documenter

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

FAQPage Schema
How do I generate architecture documentation for an existing codebase?

Generate architecture documentation by running this skill on your repository path, which uses a four-phase workflow to produce verified files like ARCHITECTURE.md and DEVELOPMENT.md, tying every factual claim to real files and scripts.

How do I prevent AI hallucinations when writing repository documentation?

Prevent AI hallucinations in repository documentation by using a verification phase that checks all referenced scripts, environment variables, and paths against the actual codebase, flagging any unverifiable items as TODO(verify).

What is the best way to create a complete set of project docs including CONTRIBUTING.md and ADRs?

Create a complete set of project docs including CONTRIBUTING.md and ADRs by synthesizing the repository's factual state into a root README with navigation and links, ensuring all outputs are traceable to real files and artifacts.

Can I automatically document repository scripts and environment variables without manual verification?

You cannot fully skip verification; the skill operates strictly within the repository context to verify all referenced scripts and environment variables against the codebase, surfacing open questions for user confirmation if items are unverifiable.

Does this documentation generation tool work without external dependencies?

Yes, this documentation generation tool works without external dependencies, operating strictly within the repository context to discover the codebase structure and produce a verified documentation set.