写作documentationreadme
从代码生成技术文档
阅读代码后输出 README 级文档：用途、架构、API、示例与常见问题。
提示词
请阅读我提供的代码/目录，生成**面向新同事**的技术文档（Markdown）。
**项目名**：{name}
**代码**：
```
{粘贴或说明路径}
```
文档需包含：
1. 一句话说明 + 适用场景
2. 快速开始（安装、最小可运行示例）
3. 架构概览（核心模块与数据流，可用 mermaid）
4. 配置项说明表
5. 公共 API / 关键函数说明（参数、返回值、副作用）
6. 常见错误与排查
7. 贡献指南要点（如何跑测试、提 PR）
要求：与代码一致；不确定处标注「待确认」。将 {花括号} 中的占位符替换为你的实际内容后再发送。
推荐配套资源
安装以下 MCP 或 Skill 后，提示词可自动读取仓库、文档或浏览器上下文，效果更好。