06-项目检查指南 - AI驱动软件著作权申请材料生成系统

📚 学习路径第6步 | 🧪 目标：验证项目完整性和系统功能正常性

🗺️ 完整学习路径：00-文档导航 → 01-快速开始 → 02-安装指南 → 03-使用说明 → 04-故障排除 → 05-FAQ → 06-项目检查指南

项目检查脚本使用指南

📋 概述

本项目提供了完整的检查脚本和质量监控体系，用于验证AI软著申请材料生成系统的完整性和功能可用性。系统包括：

基础检查工具：

🔍 验证所有必需文件和目录是否存在
⚙️ 检查配置文件格式和内容正确性
📝 验证文档引用一致性
🐍 检查Python和Shell脚本语法
📊 生成详细的健康度报告

专业质量监控工具：

🏥 项目健康诊断和自动修复
📋 需求文档质量检查和评分
📊 代码质量监控和成功率预测
👥 用户友好的交互式指导系统

🚀 快速使用

Python版本（推荐）

# 检查当前目录（完整检查）
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py

# 快速检查（跳过耗时操作）
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py --quick

# 检查指定目录
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py /path/to/project

# 查看帮助
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py --help

Shell版本（轻量级）

# 检查当前目录
./check_project.sh

# 快速检查
./check_project.sh . --quick

# 检查指定目录
./check_project.sh /path/to/project

# 查看帮助
./check_project.sh --help

📊 检查项目详解

1. 核心文件完整性检查

验证以下关键文件是否存在：

✅ 配置文件：ai-copyright-config.json
✅ 初始化脚本：init_project.py、init_project.sh、create-copyright-project
✅ 生成脚本：所有源代码生成脚本（Python和Shell版本）
✅ 文档文件：README、快速开始、使用说明等11个核心文档

2. 目录结构完整性检查

验证项目目录结构：

📁 specs_docs/ - 规范文档目录
📁 system_prompts/ - AI提示词目录
📁 requires_docs/ - 用户输入文档目录
📁 output_docs/ 和 output_sourcecode/ - 生成结果目录

3. UI设计规范文件检查

验证三种UI设计风格文件：

🏢 企业商务风格（Corporate）
🌌 暗黑科技风格（Cyberpunk）
🎨 极简主义风格（Minimal）

4. AI系统提示词完整性检查

验证8个专业AI系统提示词文件：

01-软著框架系统提示词
02-页面规划系统提示词
03-界面设计系统提示词
04-网页代码生成系统提示词
05-数据库代码生成系统提示词
06-后端代码生成系统提示词
07-用户手册系统提示词
08-软件著作权登记信息表系统提示词

5. 配置文件内容检查

验证 ai-copyright-config.json 的：

📋 JSON格式正确性
🔑 必需字段完整性（front、backend、title等）
🎨 UI设计风格值有效性（corporate/cyberpunk/minimal）

6. 脚本语法检查

验证所有脚本的语法正确性：

🐍 Python脚本语法检查
🐚 Shell脚本语法检查

7. 文档引用一致性检查

验证文档中的配置文件引用：

✅ 检查是否使用新配置文件名 ai-copyright-config.json
⚠️ 识别旧配置文件名 config.json 的残留引用

8. Git配置检查

验证版本控制配置：

📄 .gitignore 文件存在性和内容
📁 Git仓库初始化状态

📈 检查结果解读

退出码含义

0 - 检查完全通过，无错误无警告
1 - 检查基本通过，有警告需要注意
2 - 检查发现错误，需要修复

健康度分数

90-100% - 优秀，系统完全可用
80-89% - 良好，有少量警告
70-79% - 一般，需要关注警告
<70% - 需要修复错误

消息类型

✅ 成功：绿色，项目正常
⚠️ 警告：黄色，建议优化但不影响使用
❌ 错误：红色，必须修复才能正常使用
ℹ️ 信息：蓝色，提供额外信息

🔧 常见问题处理

问题1：发现旧配置文件引用

现象：警告显示文档中包含 config.json 引用

解决方案：

检查是否为说明性文本（如"从config.json更名为ai-copyright-config.json"）
如果是实际引用，需要更新为 ai-copyright-config.json

问题2：Python脚本语法错误

现象：Python脚本语法检查失败

解决方案：

检查Python版本（需要3.6+）
检查文件编码和缩进
运行 python3 -m py_compile 脚本名.py 查看详细错误

问题3：配置文件JSON格式错误

现象：配置文件格式检查失败

解决方案：

使用JSON格式验证工具检查
检查逗号、引号、大括号是否正确
确保没有多余的逗号或缺少逗号

问题4：目录或文件缺失

现象：必需文件或目录不存在

解决方案：

重新克隆或下载项目
检查是否意外删除了文件
运行初始化脚本重新创建项目结构

🎯 最佳实践

开发时使用

# 开发过程中的快速检查
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py --quick

# 提交前的完整检查
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py

CI/CD集成

# 在CI/CD管道中使用
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py
if [ $? -ne 0 ]; then
    echo "项目检查失败，停止部署"
    exit 1
fi

定期维护

# 每周运行一次完整检查
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/check_project.py > weekly_check_$(date +%Y%m%d).log

🏥 专业质量监控工具

项目健康诊断工具

python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/project_doctor.py

功能特点：

🔍 全面诊断：检查项目目录结构、配置文件、脚本文件、系统提示词、需求文档
🔧 自动修复：创建缺失目录、生成默认配置、恢复缺失脚本、设置权限
📋 详细报告：生成项目诊断报告.txt，包含问题分析和改进建议
💡 智能建议：根据项目状态提供下一步操作建议

使用场景：

新项目初始化后的完整性验证
遇到系统错误时的问题诊断
定期健康检查和维护

需求文档质量检查工具

python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/validate_requirements.py

检查维度：

📄 文档长度分析：字符数、词数统计，根据生成模式评估充实度
🔧 功能模块验证：功能描述完整性、业务流程说明
👥 用户角色定义：角色描述、权限管理相关内容
💻 技术要求检查：技术栈一致性、非功能需求描述
📚 专业术语分析：软件开发专业术语使用情况

质量评分系统：

📊 0-100分评分：综合评估文档质量
🎯 分级标准：优秀(90+)、良好(70-89)、及格(50-69)、需改进(<50)
📈 改进建议：针对性的文档优化建议

质量监控面板

python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/quality_monitor.py

监控维度：

📈 生成进度跟踪：11个阶段完成情况实时监控
💻 代码质量检测：前端、后端、数据库代码质量分析
📊 复杂度评估：函数定义、类设计、数据库结构复杂度
🎯 成功率预测：基于进度和质量预测申请成功率

智能分析特性：

🔍 多维度质量评估：文件数量、代码特征、专业性指标
📊 加权评分系统：进度40% + 质量60%的综合评分
💡 智能改进建议：基于分析结果提供具体改进方案

用户友好指导系统

python3 /path/to/AI-Copyright-Application-Generator/scripts/user_guide.py

交互式功能菜单：

🏥 项目健康诊断 - 检查项目状态，自动修复问题
📝 需求文档质量检查 - 验证文档质量，获得改进建议
📊 质量监控面板 - 监控生成进度和代码质量
🔧 代码合并工具 - 将生成的代码合并为申请文档
📋 查看项目状态 - 查看当前项目的整体状态
💡 获取操作建议 - 根据项目状态获得下一步建议
📚 查看帮助文档 - 查看详细的使用说明

智能特性：

🎯 状态感知建议：根据项目实际状态提供针对性建议
🔄 一键工具调用：集成所有验证和监控工具
📊 实时状态反馈：动态显示项目完成度和质量指标

🔍 专项验证工具

前端页面完整性验证

验证AI生成的前端页面是否完整：

# 验证前端页面完整性
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/validate_frontend_pages.py

验证内容包括：

✅ 页面清单中定义的所有页面是否都已生成
✅ HTML文件的基本结构完整性（DOCTYPE、head、body等）
✅ CSS样式是否存在
✅ 是否存在AI省略的内容标记
✅ 汇总文档（前端源代码.txt）的完整性

使用场景：

AI生成前端代码后的质量检查
发现前端源代码.txt文档不完整时的诊断
确保软著申请材料的代码完整性

自动化测试套件

运行完整的自动化测试验证系统功能：

# 运行所有自动化测试
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/run_tests.py

# 检查指定项目目录
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/run_tests.py /path/to/project

测试内容包括：

项目结构完整性
配置文件有效性
脚本语法正确性
UI设计规范文件
AI系统提示词文件
检查脚本功能
初始化脚本导入
文档完整性
模板创建功能

📅 更新检查脚本

添加新检查项

在 check_project.py 中添加新的检查函数
在 run_all_checks() 中调用新函数
在 check_project.sh 中添加对应的Shell版本

修改检查标准

更新相应的检查函数
修改错误/警告消息
更新本文档说明

🔗 相关文档

01-快速开始.md - 项目快速上手
03-使用说明.md - 详细使用指南
04-故障排除.md - 问题解决方案

💡 提示：建议在每次项目更新后运行检查脚本，确保系统完整性和功能正常。

06-项目检查指南.md 11 KB Permalink History Raw

06-项目检查指南 - AI驱动软件著作权申请材料生成系统

项目检查脚本使用指南

📋 概述

🚀 快速使用

Python版本（推荐）

Shell版本（轻量级）

📊 检查项目详解

1. 核心文件完整性检查

2. 目录结构完整性检查

3. UI设计规范文件检查

4. AI系统提示词完整性检查

5. 配置文件内容检查

6. 脚本语法检查

7. 文档引用一致性检查

8. Git配置检查

📈 检查结果解读

退出码含义

健康度分数

消息类型

🔧 常见问题处理

问题1：发现旧配置文件引用

问题2：Python脚本语法错误

问题3：配置文件JSON格式错误

问题4：目录或文件缺失

🎯 最佳实践

开发时使用

CI/CD集成

定期维护

🏥 专业质量监控工具

项目健康诊断工具

需求文档质量检查工具

质量监控面板

用户友好指导系统

🔍 专项验证工具

前端页面完整性验证

自动化测试套件

📅 更新检查脚本

添加新检查项

修改检查标准

🔗 相关文档

06-项目检查指南.md 11 KB

Permalink History Raw