首页 AI系列81:根据代码反推文档提示词1
文章
取消

AI系列81:根据代码反推文档提示词1

项目扫描

请对整个项目进行全面扫描分析,按以下结构输出详细信息:

1. 项目基础信息

  • 项目类型:[Web应用/API服务/桌面应用/移动应用/库/工具等]
  • 主要功能:[从README、package.json等推断项目的核心功能]
  • 项目规模:[小型<1万行/中型1-10万行/大型>10万行]
  • 开发状态:[活跃开发/维护状态/遗留项目]

2. 技术栈深度分析

  • 编程语言:[主要语言及版本,次要语言]
  • 核心框架:[主框架名称及版本]
  • 关键依赖库:[列出5-10个最重要的依赖,含版本]
  • 数据库技术:[数据库类型、ORM框架等]
  • 构建工具:[构建系统、包管理器、CI/CD工具]
  • 部署方式:[容器化、云平台、传统部署等]

3. 项目结构分析

  • 入口文件:[主要入口文件路径]
  • 核心目录:[列出5-8个最重要的目录及其作用]
  • 配置文件:[重要配置文件位置和作用]
  • 文档情况:[README、API文档、注释覆盖率等]

4. 代码规模统计

  • 总文件数:[大概数量]
  • 代码文件数:[排除配置、文档等]
  • 估算代码行数:[基于文件数量和复杂度估算]
  • 目录层级深度:[最深层级数]

5. 项目复杂度评估

  • 架构复杂度:[单体/分层/微服务/分布式]
  • 业务复杂度:[简单/中等/复杂,基于目录结构判断]
  • 技术复杂度:[技术栈数量、集成复杂度]
  • 维护难度:[基于代码组织、文档情况评估]

6. 关键文件识别

  • 配置文件:[package.json、pom.xml、requirements.txt等]
  • 启动文件:[main.js、app.py、Application.java等]
  • 路由文件:[路由定义文件位置]
  • 数据模型:[实体类、模型定义文件]
  • API定义:[接口定义、控制器文件]

7. 初步问题识别

  • 缺失文档:[哪些重要文档缺失]
  • 配置问题:[配置文件是否完整、环境变量等]
  • 依赖问题:[过时依赖、安全漏洞等]
  • 代码组织:[目录结构是否合理、命名规范等]

8. 后续分析建议

  • 重点关注模块:[基于复杂度和重要性,建议重点分析的模块]
  • 分析顺序建议:[建议的模块分析优先级]
  • 特别注意事项:[分析过程中需要特别注意的点]

输出要求

  • 使用Markdown格式
  • 保存到:docs/01-项目扫描报告.md
  • 如有不确定的信息,标注”[需要确认]”
  • 为每个发现提供具体的文件路径作为证据
  • 重点标注影响后续分析的关键信息

质量检查

完成后请自检:

  1. 所有提到的文件路径是否真实存在
  2. 技术栈信息是否准确(检查版本号)
  3. 项目规模评估是否合理
  4. 是否遗漏了重要的配置或入口文件
  5. 复杂度评估是否与实际代码结构匹配
本文由作者按照 CC BY 4.0 进行授权

AI系列80:AI法律助手排行

AI系列82:项目架构文档生成提示词2