generate-readmelisted
Install: claude install-skill tranviet0710/agent-skills
# Generate README from Implementation
## When to Use
Invoke this skill when the user says:
- "generate a README for this"
- "create a README based on the implementation"
- "document this feature / module / project"
- "write a README for [folder]"
- "generate docs from the code"
## Procedure
### Step 1 — Locate the Implementation
1. Identify the **target scope**: a folder, a single file, or the entire workspace root.
2. List all files in the target scope (recursively if a folder).
3. Read the key source files — entry points, main modules, config files, and any existing partial docs.
4. If a `TASKS.md` or `PLAN.md` exists in the same folder, read it for context on intent and scope.
### Step 2 — Extract Key Information
While reading the code, collect the following details:
| Category | What to look for |
|----------|-----------------|
| **Purpose** | What problem does this solve? What is the main feature/module? |
| **Inputs / Outputs** | CLI args, function params, API endpoints, events consumed/produced |
| **Configuration** | Environment variables, config files, feature flags |
| **Dependencies** | External packages, services, or APIs relied upon |
| **Usage examples** | Invocation patterns, code snippets, sample commands |
| **Folder structure** | Notable sub-folders and their roles |
| **Setup / Installation** | Build steps, install commands, prerequisites |
| **Limitations / Notes** | Known edge cases, TODOs, constraints |
### Step 3 — Ask Clarifying Questions
Bef