Technical Doc from Code
Produce README-quality docs: purpose, architecture, API, examples, and FAQ from code.
Prompt
Style:
Interactive Fill-in (Auto replaces below)
Read the code below and write onboarding-friendly technical documentation (Markdown).
**Project**: {name}
**Code**:
```
{paste or paths}
```
Include:
1. One-liner + when to use
2. Quick start
3. Architecture overview (mermaid ok)
4. Configuration table
5. Public API / key functions
6. Troubleshooting FAQ
7. Contribution notes (tests, PRs)
Match the code; mark uncertain parts as TBD.Copy & open AI model directly:
Recommended companions
Install these MCP servers or Skills so the AI can pull repo, docs, or browser context automatically.