generating-project-docs

Installation
SKILL.md

Generating Project Documentation

Overview

This plugin's documentation describes a live system whose surface (skills, agents, config schema, CLI) keeps changing. Generated docs go stale fast.

Core principle: Derive every fact from the live repository. Preserve the existing document's evolved structure. Never regress to a generic template.

If you cannot point at a file or command that justifies a sentence, do not write it.

When to Use

  • Refreshing README.md after new skills, agents, or features land
  • Fixing documentation drift (counts, structure, CLI output, runtime claims)
  • Updating ARCHITECTURE.md or STRUCTURE.md when the codebase layout changes
  • Adding or refreshing a scoped section (e.g. only the "Quick Install" block)

When NOT to Use

Installs
2
GitHub Stars
23
First Seen
Jun 16, 2026
generating-project-docs — marcusrbrown/systematic