ProjectDocHelper

基本能力

产品定位

ProjectDocHelper 是一个专注于自动生成项目文档的工具，通过与 AI 开发工具（如 Cursor）的集成，提升开发效率和文档质量。

核心功能

• 智能文档生成：根据项目类型自动生成文档集。
• 多种生成模式：支持简单和详细两种生成模式。
• 进度可视化：在文档生成过程中显示进度条。
• MCP 服务支持：启动服务后，Cursor 等工具可以访问生成的文档。
• Q&A 集成：支持将用户与 AI 的交互内容整合到文档中。

适用场景

• 需要快速生成项目文档的开发团队。
• 希望通过 AI 工具提升开发效率的个人或团队。
• 需要将用户与 AI 的交互内容整合到文档中的场景。

工具列表

• projectdochelper generate：生成项目文档的命令行工具，支持简单和详细模式。
• projectdochelper serve：启动 MCP 服务，使 AI 工具可以访问生成的文档。

常见问题解答

• 如何集成到 Cursor：启动 ProjectDocHelper 服务后，在 Cursor 中配置 MCP 服务地址即可。
• 文档生成模式的区别：简单模式生成基础文档，详细模式生成更全面的文档集。

使用教程

使用依赖

• Python 3.12+
• 安装依赖命令： bash pip install argparse Jinja2

安装教程

pip install projectdochelper

基本使用

# 生成项目文档（简单模式）
projectdochelper generate --mode simple

# 生成项目文档（详细模式）
projectdochelper generate --mode detailed

# 启动 MCP 服务
projectdochelper serve --port 8080

调试方式

• 启动服务后，可以通过访问 http://localhost:8080 来验证服务是否正常运行。
• 使用日志功能查看生成过程中的详细信息。

许可证

该项目遵循 MIT 开源许可条款。