gen-docs
Installation
SKILL.md
Documentation Generator
Overview
Generate or update the four-doc project documentation set: README.md, README.ko.md, ARCHITECTURE.md, and USAGE.md.
Core principle: README.md is the front door. Keep it short, link to deeper docs, preserve human prose, and write only after the user has seen the diff.
REQUIRED BACKGROUND: Use writing-skills before editing this skill itself. New skill behavior must be tested with baseline failures first.
Document Contract
| File | Role |
|---|---|
README.md |
English front door: pitch, highlights, primary install path, one quick start, links to deeper docs, license |
README.ko.md |
Faithful Korean mirror of README.md; preserve code, commands, flags, file names, and proper nouns verbatim |
ARCHITECTURE.md |
Components, responsibilities, data flow, directory map, design decisions |
USAGE.md |
Detailed install, command/API reference, configuration, examples, troubleshooting |