repo-docs

Synchronize repository documentation with source code using doc-first workflows.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/mjamore/repo-docs-skill --skill repo-docs-mjamore
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-docs
Source: https://github.com/mjamore/repo-docs-skill/tree/main/repo-docs
Command: npx skills add https://github.com/mjamore/repo-docs-skill --skill repo-docs-mjamore

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Repository documentation drifts from source code, causing confusion for developers and AI agents, and requires tedious manual updates.

Core Features & Use Cases

  • Automatic scaffold creation: Generates the full /docs structure with essential files when missing.
  • Doc‑first workflow enforcement: Reads AGENTS.md, work‑in‑progress, plans, and specs in a defined order before any code changes.
  • Plan and spec management: Creates, updates, archives plans and specs with strict naming and linking rules, ensuring progressive disclosure.
  • Audit and closeout: Runs /repo-docs-audit, validates synchronization, and reports updated spec paths.

Quick Start

Ask the repo-docs skill to bootstrap the documentation scaffold for a new repository.

Frequently Asked Questions about repo-docs

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

FAQPage Schema
How do I keep repository documentation synchronized with source code?

To keep repository documentation synchronized with source code, apply a doc-first workflow skill that reads plans and specs before code changes, automates auditing, and enforces relative markdown linking to eliminate drift.

What is a doc-first workflow for managing plans and specs?

A doc-first workflow requires reading AGENTS.md, work-in-progress documents, plans, and specs in a defined order before making any code changes, ensuring documentation drives development and stays perfectly aligned.

How do I automatically generate a docs folder structure for a new repository?

You can automatically generate a docs folder structure by asking the skill to bootstrap the documentation scaffold, which creates the full /docs directory with essential files and progressive disclosure links when missing.

How do I audit repository documentation for drift against source code?

To audit repository documentation for drift, run the /repo-docs-audit command, which validates synchronization between specs and code, reports updated spec paths, and automates plan archiving without manual intervention.

Can I enforce relative markdown linking and progressive disclosure in my project docs?

Yes, you can enforce relative markdown linking and progressive disclosure by applying this skill to manage plans and specs with strict naming and linking rules, maintaining documentation structure automatically during development.

Why does my repository documentation keep drifting from the actual source code?

Repository documentation drifts from source code because manual updates are tedious and often skipped, requiring an automated synchronization tool that enforces a doc-first workflow and validates spec paths during audits.