菜单
Generate concise documentation from code. README, function docs, API references, architecture notes — written in plain language, with examples that work, no padding. Use when shipping or onboarding and you want docs that read fast and stay accurate.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | maji-doc |
| description | Generate concise documentation from code. README, function docs, API references, architecture notes — written in plain language, with examples that work, no padding. Use when shipping or onboarding and you want docs that read fast and stay accurate. |
A skill that reads code (file, module, project) and writes documentation that's actually useful — no padding, no platitudes, examples that work.
Type maji-doc <target> where target is:
maji-doc src/auth.ts)maji-doc src/api/)maji-doc . — generates README)maji-doc src/utils.ts:debounce)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
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]
[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
| ❌ Avoid | ✅ Do instead |
|---|---|
| "This function takes a number and returns a number" | square(n) — returns n × n |
| "Comprehensive guide to..." (then 5 paragraphs) | Quick start + reference link |
| Documenting auto-generated boilerplate | Skip; the code is the doc |
| "Please see the documentation" links to nothing | Either link to real doc or write it inline |
| Explaining what's visible in the code | Explain decisions hidden in the code |
Input:
export async function debounce<T extends (...args: any[]) => any>(
fn: T,
ms: number
): Promise<T> {
let timer: NodeJS.Timeout
return ((...args: Parameters<T>) => {
clearTimeout(timer)
timer = setTimeout(() => fn(...args), ms)
}) as T
}
Output:
debounce(fn, ms) — wraps a function so it only fires after ms milliseconds of silence.
Args:
- fn (function) — function to debounce
- ms (number) — silence period in milliseconds
Returns: a debounced version of fn with the same signature.
Example:
const search = debounce((query) => fetchResults(query), 300)
input.addEventListener('input', e => search(e.target.value))
// fires once, 300ms after user stops typing
Notes:
- `this` binding is lost — use arrow functions or bind explicitly if needed
- Cancel pending call by reassigning the reference
maji-explain — for understanding code firstmaji-review — to spot undocumented public APIsmaji-mode — token discipline applies (no padding)Common adjustments via fork:
maji-doc is part of MAJI Skills · By MAJI · No Codes, Only Vibes.
Scope-guarded refactoring. Define target → identify minimum diff → preserve behaviour → verify with tests. Pre-Action Gate prevents scope drift into unrelated improvements. Use when you want a targeted refactor that does not turn into a 50-file rewrite.
Compress long content into structured summary. TLDR + key points + action items, length-tunable. Use for meeting notes, transcripts, long docs, threads, codebases. No padding, no editorial commentary.
Generate disciplined test cases. Focus on behaviour not implementation, cover edge cases without bloat, name tests for the case not the function. Use when writing tests for new code or filling gaps in coverage.
Extract and triage TODO/FIXME/HACK comments from a codebase. Categorize by urgency, group by file, identify stale TODOs older than threshold. Use during cleanup sprints, before releases, or when onboarding a new project.
Generate a concise commit message from the current git diff. Conventional commits format (feat/fix/refactor/etc). Use when staged changes are ready to commit and you want Claude to write the message instead of typing it manually.
Disciplined debug session protocol. Read symptom → form hypothesis → verify before fixing → propose minimum-change fix. Pre-Action Gate prevents hasty rewrites that break unrelated code. Use when an error or unexpected behaviour appears and you want a focused diagnosis instead of guess-and-check.