基本能力
产品定位
Autodocument是一个自动化代码文档生成工具，旨在帮助开发者快速生成和维护代码仓库的文档、测试计划和代码审查报告。
核心功能
- 智能目录分析：递归分析代码仓库中的目录和文件
- Git集成：遵循
.gitignore规则跳过忽略的文件 - AI驱动的文档生成：使用OpenRouter API（默认Claude 3.7）生成全面的文档
- 测试计划生成：自动创建包含测试类型、边界条件和模拟需求的测试计划
- 代码审查：执行高级开发者级别的代码审查，关注安全性、最佳实践和改进建议
- 自底向上方法：从叶子目录开始向上工作，创建连贯的文档层次结构
- 智能文件处理：
- 在每个目录级别创建
documentation.md、testplan.md和review.md文件 - 跳过单文件目录但将其内容包含在父级输出中
- 支持更新现有文件
- 为超出限制的目录创建备用文件
- 进度报告：提供详细的进度更新，防止长时间操作超时
- 高度可配置：可自定义文件扩展名、大小限制、模型、提示等
- 可扩展架构：模块化设计便于未来添加更多自动化工具
适用场景
- 需要快速为新项目生成文档
- 维护大型代码库的文档
- 自动化生成测试计划
- 进行代码质量审查
- 提高开发团队的生产力
工具列表
- generate_documentation：为代码仓库生成全面的文档
- autotestplan：为代码仓库生成测试计划
- autoreview：为代码仓库生成高级开发者级别的代码审查报告
常见问题解答
- API密钥问题：确保设置了
OPENROUTER_API_KEY环境变量，检查OpenRouter账户是否活跃 - 大小限制错误：通过设置
MAX_FILE_SIZE_KB和MAX_FILES_PER_DIR环境变量增加限制 - 模型选择：如果不满意文档质量，可以尝试通过设置
OPENROUTER_MODEL环境变量更换模型
使用教程
使用依赖
- Node.js (v16或更新版本)
- OpenRouter API密钥
安装教程
```bash
克隆仓库
git clone https://github.com/PARS-DOE/autodocument.git
cd autodocument
安装依赖
npm install
构建项目
npm run build
```
调试方式
```bash
导航到克隆的仓库
cd path/to/cloned/autodocument
设置API密钥
export OPENROUTER_API_KEY=your-api-key-here
在项目上运行文档生成
node build/index.js /path/to/your/project
```
