From makeDoc
Generates or updates professional technical documentation for GitHub projects. Use /makeDoc to generate from scratch, /makeDoc --update to update, /makeDoc --agent to run in a subagent.
How this skill is triggered — by the user, by Claude, or both
Slash command
/makeDoc:makeDocThis skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
Detect the received flags:
Detect the received flags:
--update → update mode--agent → delegate to the makeDoc-agent agent--agent --update → delegate to the agent with the --update flag--agent:Delegate the entire task to the makeDoc-agent agent using the subagent tool.
Pass as prompt:
--agentExample prompt to the agent:
Run the makeDoc skill in the directory: /path/to/project
Flags: --update
Do not perform any exploration or generation yourself. Everything is handled by the agent.
--agent:Explore the current project before writing any file. Do not generate generic content: everything must be specific to the code you are reading.
Follow this process:
Creation mode (no flag):
/docs or README.md already exist, warn the user they will be replaced and continueUpdate mode (--update):
README.mddocs/*.mdBefore writing anything, survey the project:
If the project is large, prioritize:
Before generating any file, answer these internally:
In --update mode, also:
Write the following files in the project root directory:
README.mddocs/architecture.mddocs/structure.mddocs/installation.mddocs/decisions.mddocs/api.md → if there are HTTP endpoints, CLI, or a public interfacedocs/testing.md → if there are tests or a testing framework configureddocs/usage.md → if the project has a user interface, non-trivial usage flows, or CLI commands# Project Name
## 📚 Documentation
| | |
|---|---|
| [⚙️ Architecture](docs/architecture.md) | System design, components and flow |
| [📁 Structure](docs/structure.md) | Project organization and responsibilities |
| [🚀 Installation](docs/installation.md) | Requirements and steps to run the project |
| [🧠 Technical decisions](docs/decisions.md) | Trade-offs and design justifications |
| [📖 Usage guide](docs/usage.md) | How to use the project, flows and examples *(if applicable)* |
| [🔌 API](docs/api.md) | Endpoints, request/response and examples *(if applicable)* |
| [🧪 Testing](docs/testing.md) | How to run tests and coverage strategy *(if applicable)* |
---
## Description
- What it does
- What problem it solves
- Real use case
## Quick start
Concrete, executable example
## Technologies used
Split into categories as applicable
## Quick installation
Summary in 2-3 steps. Link to docs/installation.md
## Architecture (summary)
Short paragraph. Link to docs/architecture.md
## Project structure
Summarized tree. Link to docs/structure.md
Aimed at the end user or developer who will use the project, not the one who will modify it.
Do not repeat information from installation.md. Assume the project is already running.
⚠️ Not verified in generated files. Report omissions only in the final summary to the user, not inside the files.Report to the user:
--update mode)--update mode)Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Applies a firm's KYC/AML rules grid to parsed onboarding records: assigns risk rating, checks required documents, outputs rule outcomes with citations, and routes for escalation.
Generates daily or weekly digests of activity from connected sources (chat, email, docs, tasks, CRM), highlighting action items, decisions, mentions, and project updates.
npx claudepluginhub maximilianozurita/makedoc --plugin makeDoc