maji-doclisted

# maji-doc — Concise Documentation Generator A skill that reads code (file, module, project) and writes documentation that's actually useful — no padding, no platitudes, examples that work. --- ## When to Use Type `maji-doc <target>` where target is: - A file (`maji-doc src/auth.ts`) - A folder (`maji-doc src/api/`) - A whole project (`maji-doc .` — generates README) - A function/class (`maji-doc src/utils.ts:debounce`) --- ## Output Types ### 1. README (project-level) Sections in order: ``` # Project Name 1-sentence what-it-does ## Quick Start 3-step install + minimal usage ## Features 3-7 bullets — actual capabilities, not marketing ## Usage 1-2 concrete examples that work ## API / Reference Public surface only ## License ``` ### 2. Function/Class Docs ``` funcName(args) — 1-sentence purpose. Args: - arg1 (type) — what it is - arg2 (type) — what it is Returns: (type) — what comes back Example: [code, 3-5 lines] Notes (if non-obvious): - [edge case, gotcha, performance] ``` ### 3. Architecture Notes ``` [Component] — what role it plays. Inputs: where data comes in Outputs: where data goes Dependencies: what it needs to function Failure modes: what breaks it ``` --- ## Rules - **Write WHY for non-obvious choices, never WHAT for obvious code** - **Examples must run** — copy-paste should work without modification - **Use plain English** — no "leverage", "utilize", "facilitate" - **No padding** — drop "This function" / "It is responsible for..." preamb