03-使用说明.md 21 KB

03-使用说明 - AI驱动软件著作权申请材料生成系统

📚 学习路径第3步 | 📖 目标:掌握系统完整功能和六阶段优化材料生成流程(2025年升级版)

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

系统架构

核心组件

  • 8个专业AI提示词:覆盖软著申请的所有材料类型,包含中文变量说明提升易用性
  • 六阶段优化生成流程:高效生成专业材料,从原8阶段精简优化(2025年升级)
  • 增强变量系统:18个系统变量均配备中文说明,如{{title}}(系统完整名称)、{{requirements_description}}(需求描述)等
  • 自动化脚本:一键生成源代码文档
  • 标准化输出:符合软著申请格式要求

输入输出关系

需求文档 → AI提示词 → 生成材料 → 软著申请包

新手指引

如果您是第一次使用,建议按此顺序阅读:

  1. 01-快速开始.md - 5分钟创建首个项目
  2. 本文档 - 了解完整功能和流程
  3. 02-安装指南.md - 如遇环境问题

项目初始化

创建新项目

# 推荐方式:使用初始化脚本(绝对路径)
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py <项目名称>

# 备选方式:直接复制主模板
cp -r "AI-Copyright-Application-Generator" "您的新项目名称"

初始化脚本会自动:

  • 创建标准目录结构
  • 复制所有AI提示词文件和十二种UI设计规范模板
  • 交互式选择UI设计风格(12种选择)
  • 生成配置文件模板(包含选择的UI风格)
  • 创建需求文档模板

可选输入文档

用户可以根据项目需要提供以下可选文档:

技术栈说明文档(可选)

  • 位置requires_docs/技术栈说明文档.md
  • 用途:自定义项目的技术栈配置
  • 说明:如不提供,系统使用默认技术栈模板

UI设计规范配置

系统提供十二种专业UI设计风格,用户可通过以下方式选择:

方式一:预设风格选择(推荐)

  • 配置位置ai-copyright-config.json 中的 ui_design_style 参数
  • 可选值
    • "corporate" - 企业商务风格(默认):适合管理系统、办公软件
    • "cyberpunk" - 暗黑科技风格:适合开发工具、数据分析平台
    • "minimal" - 极简主义风格:适合内容管理、教育平台
    • "bauhaus" - 包豪斯风格:适合设计工具、建筑系统
    • "japanese" - 日式极简风格:适合冥想应用、文化平台
    • "scandinavian" - 斯堪的纳维亚风格:适合生活应用、健康平台
    • "futuristic" - 未来科技风格:适合数据平台、安全系统
    • "elegant" - 优雅复古风格:适合文化教育、学术研究
    • "bold" - 大胆现代风格:适合创意平台、时尚品牌
    • "artdeco" - 艺术装饰风格:适合奢侈品电商、高端服务
    • "memphis" - 孟菲斯风格:适合创意设计、娱乐媒体
    • "popart" - 波普艺术风格:适合娱乐平台、时尚购物
  • 设置:项目初始化时交互选择,或手动修改配置文件

方式二:自定义UI规范(最高优先级)

  • 位置requires_docs/UI设计规范.md
  • 用途:定义项目专属的UI设计风格和规范
  • 说明:自定义规范会覆盖预设风格选择
  • 优势:有助于体现软件的设计创新和独特性

目录结构说明

项目名称/
├── ai-copyright-config.json                    # 项目配置文件(包含UI风格选择)
├── specs_docs/                     # 🎨 固定规范文档
│   ├── ui_design_specs/           # UI设计规范(十二种风格)
│   │   ├── 01-UI设计规范_默认_Corporate.md
│   │   ├── 02-UI设计规范_暗黑科技风格_Cyberpunk.md
│   │   ├── 03-UI设计规范_极简主义风格_Minimal.md
│   │   ├── 04-UI设计规范_包豪斯风格_Bauhaus.md
│   │   ├── 05-UI设计规范_日式极简风格_Japanese.md
│   │   ├── 06-UI设计规范_斯堪的纳维亚风格_Scandinavian.md
│   │   ├── 07-UI设计规范_未来科技风格_Futuristic.md
│   │   ├── 08-UI设计规范_优雅复古风格_Elegant.md
│   │   ├── 09-UI设计规范_大胆现代风格_Bold.md
│   │   ├── 10-UI设计规范_艺术装饰风格_ArtDeco.md
│   │   ├── 11-UI设计规范_孟菲斯风格_Memphis.md
│   │   └── 12-UI设计规范_波普艺术风格_PopArt.md
│   └── tech_stack_specs/          # 技术栈规范
├── requires_docs/                 # 📝 输入文档
│   └── 需求文档.md                # 用户填写的项目需求
├── system_prompts/                 # 🤖 8个专业AI系统提示词
├── scripts/                       # 🔧 自动化工具和验证脚本
│   ├── generators/                # 代码合并和生成脚本
│   └── validators/                # 质量监控和验证工具
├── process_docs/                  # 📋 中间生成文档
├── output_docs/                   # 📄 最终申请材料
└── output_sourcecode/             # 💻 生成的源代码
    ├── front/                     # 前端代码
    ├── backend/                   # 后端代码
    └── db/                        # 数据库代码

核心文件说明

  • ai-copyright-config.json:项目基本信息配置(包含UI设计风格选择)
  • 需求文档.md:用户输入的软件项目详细需求(关键)
  • specs_docs/ui_design_specs/:十二种专业UI设计规范模板
  • 8个AI提示词:生成不同类型软著材料的专业模板
  • output_docs/:最终的软著申请材料包

项目创建和配置

项目创建方式

使用初始化脚本(推荐)

优势

  • 交互式UI风格选择
  • 自动配置项目信息
  • 可在任意目录创建
  • 支持自定义技术栈选择

使用方法

# 在任意工作目录创建项目(推荐)
cd /your/workspace
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py "项目名称"

# 或者使用绝对路径示例
python3 /Users/username/AI-Copyright-Application-Generator/scripts/init/init_project.py "项目名称"

# 配置全局命令后使用
create-copyright-project "项目名称"

交互流程

  1. 输入系统完整名称和简称
  2. 选择前后端技术栈
  3. 选择UI设计风格(12种专业风格)
  4. 选择是否使用自定义技术栈文档
  5. 自动生成完整项目结构

直接复制模板

优势:快速复制,适合批量创建

cp -r "AI-Copyright-Application-Generator" "新项目名称"
cd "新项目名称"
# 手动编辑 ai-copyright-config.json

配置文件详解

重要变更(2025年升级):

  • 配置文件已从 config.json 更名为 ai-copyright-config.json,避免与其他开源项目冲突
  • 变量命名优化:system_profilerequirements_description(需求描述),deploy_requirementscopyright_application(软件著作权登记信息表)
  • 所有系统变量现均包含中文说明,提升用户体验

配置文件包含三个主要部分:

  1. 项目初始化配置(用户必须设置)
  2. 使用说明和注释(指导用户配置)
  3. 系统固定配置(请勿修改)

关键配置项

  • ui_design_style:UI设计风格选择(12种专业风格)
  • titleshort_title:软件系统名称
  • frontbackend:技术栈配置
  • requirements_description:需求描述文档路径(更名后)
  • copyright_application:软件著作权登记信息表路径(更名后)

系统变量增强:所有变量现均包含中文说明,如{{title}}(系统完整名称)、{{requirements_description}}(需求描述)等,增强可读性和用户体验。

六阶段优化材料生成流程

🎯 阶段一:项目初始化和系统架构设计

核心目标:建立项目技术基础和系统架构

操作步骤

  1. 项目配置初始化 - 检查 ai-copyright-config.json 配置完整性
  2. 系统架构设计 - 使用 01-软著框架系统提示词.md 生成技术架构文档
  3. 技术栈确认 - 完善技术选型和配置管理

输出文档process_docs/框架设计文档.md

🎨 阶段二:产品规划和界面设计

核心目标:完成产品功能规划和UI设计方案

详细操作

  1. 产品功能规划

    • 使用 02-页面规划系统提示词.md 生成页面清单和功能模块
    • 支持fast模式(5个核心页面)和full模式(10个完整页面)
    • 保存为 process_docs/页面规划.md
  2. 界面设计规范

    • 使用 03-界面设计系统提示词.md 完成UI设计和导航架构
    • 自动应用选择的UI设计风格(12种专业风格可选)
    • 保存为 process_docs/界面设计方案.md

推荐页面类型

  • 用户认证(登录/注册)
  • 系统仪表板/首页
  • 核心业务管理页面(3-4个)
  • 数据管理(录入/查询/编辑)
  • 系统管理(用户/权限/配置)
  • 数据统计分析和报表展示
  • 消息通知/日志管理
  • 帮助文档/关于页面
  • 个人中心/用户设置

输出文档

  • process_docs/页面规划.md
  • process_docs/界面设计方案.md

💻 阶段三:前端开发实现

核心目标:生成完整前端源代码和页面实现

详细操作

  1. 前端页面开发

    • 使用 04-网页代码生成系统提示词.md 生成所有页面代码
    • 为每个页面生成完整HTML代码
    • 保存到 output_sourcecode/front/ 目录
  2. 前端代码整合

    python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_frontend_simple.py
    # 或使用新版合并脚本:
    python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_frontend_simple.py
    

输出文档和代码

  • output_sourcecode/front/ - 完整前端源代码
  • output_docs/前端源代码.txt - 软著申请前端材料(60+页)

🗄️ 阶段四:后端系统开发

核心目标:实现数据库设计和后端系统开发

详细操作

  1. 数据库设计

    • 使用 05-数据库代码生成系统提示词.md 生成数据库架构
    • 生成完整的SQL数据库设计
    • 直接保存为 output_docs/数据库代码.txt
  2. 后端系统开发

    • 使用 06-后端代码生成系统提示词.md 生成Spring Boot应用
    • 包含Controller、Service、Entity、Repository等完整结构
    • 保存到 output_sourcecode/backend/ 目录
  3. 后端代码整合

    python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_backend_simple.py
    # 或使用新版合并脚本:
    python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_backend_simple.py
    

输出文档和代码

  • output_sourcecode/backend/ - 完整后端源代码
  • output_sourcecode/db/ - 数据库脚本
  • output_docs/数据库代码.txt - 数据库设计文档
  • output_docs/后端源代码.txt - 软著申请后端材料(60+页)

📋 阶段五:软著申请文档生成

核心目标:生成软著申请所需的全部文档材料

详细操作

  1. 用户手册生成

    • 使用 07-用户手册系统提示词.md 生成用户操作文档
    • 生成详细的用户操作指南
    • 保存为 output_docs/用户手册.txt
  2. 软著申请表生成

    • 使用 08-软件著作权登记信息表系统提示词.md 生成申请表
    • 生成标准的软著申请表格
    • 保存为 output_docs/软件著作权登记信息表.md

输出文档

  • output_docs/用户手册.txt - 用户操作指南
  • output_docs/软件著作权登记信息表.md - 软著申请表

📦 阶段六:材料整理和质量验收

核心目标:整理完整软著申请材料包并进行质量验收

最终操作

# 一键生成所有源代码汇总文档
python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_all_simple.py
# 或使用新版合并脚本:
python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_all_simple.py

# 检查材料完整性
ls output_docs/

# 质量验收
python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/quality_monitor.py

最终输出材料清单

  • 软件著作权登记信息表.md - 申请表格
  • 前端源代码.txt - 前端代码文档(60+页)
  • 后端源代码.txt - 后端代码文档(60+页)
  • 数据库代码.txt - 数据库设计文档
  • 用户手册.txt - 用户操作手册
  • process_docs/框架设计文档.md - 技术架构说明

专业AI提示词说明

8个专业提示词(按工作流程使用顺序):

  1. 01-软著框架系统提示词 → 技术架构文档(阶段一)
  2. 02-页面规划系统提示词 → 前端页面规划(阶段二)
  3. 03-界面设计系统提示词 → UI设计和导航架构(阶段二)
  4. 04-网页代码生成系统提示词 → 前端HTML代码(阶段三)
  5. 05-数据库代码生成系统提示词 → 数据库设计(阶段四)
  6. 06-后端代码生成系统提示词 → 后端业务代码(阶段四)
  7. 07-用户手册系统提示词 → 用户操作文档(阶段五)
  8. 08-软件著作权登记信息表系统提示词 → 申请表格(阶段五)

关键成功要素

需求文档质量 📋

最重要:需求文档是整个系统的核心输入

  • 详细程度:建议不少于1000字
  • 必需内容
    • 系统概述和目标用户
    • 核心功能模块(3-5个)
    • 特色创新点(软著申请关键)
    • 技术架构要求
    • 业务流程说明

AI工具使用技巧 🤖

  • 推荐AI工具:Claude、ChatGPT-4、ChatGPT-3.5
  • 使用方法
    1. 完整复制AI提示词
    2. 附加您的需求文档内容
    3. 要求AI按格式生成材料
    4. 对不满意的部分要求重新生成

代码量和质量标准 💻

  • 前端代码:根据模式生成5-10个HTML页面,总计800-1500+行
  • 后端代码:15-20个Java类,总计2000+行
  • 数据库设计:5-8个数据表,完整SQL
  • 总体要求:代码结构清晰,功能完整,体现软件复杂性

软著申请材料标准 📄

  • 专业性:技术文档体现开发的专业水平
  • 原创性:代码和设计展示软件的创新性
  • 完整性:涵盖前端、后端、数据库完整技术栈
  • 规范性:严格按照软著申请格式要求

常见问题和解决方案

生成材料质量不佳

原因:需求文档不够详细 解决:完善需求文档,增加功能描述和创新点说明

AI生成内容重复或格式错误

原因:提示词使用不当 解决:严格按顺序使用提示词,确保输入完整的需求信息

源代码文档生成失败

原因:源代码文件不足或格式问题 解决:确保生成足够数量的代码文件后再运行脚本

申请材料不符合要求

原因:未按软著申请标准生成 解决:严格按照六阶段优化流程执行,使用系统提供的AI提示词

质量监控和验证工具 🛡️

系统提供了专业的质量监控和验证工具,确保生成的软著申请材料符合专业标准:

项目健康诊断工具

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分质量评分系统
  • 输出报告requires_docs/需求文档质量报告.txt

质量监控面板

python3 /path/to/AI-Copyright-Application-Generator/scripts/validators/quality_monitor.py
  • 功能:全方位监控生成过程的质量,提供实时反馈
  • 监控维度:生成进度跟踪、代码质量检测、文档完整性验证、申请成功率预测
  • 智能分析:代码复杂度分析、专业性评估、成功率预测
  • 输出报告质量监控报告.txt

用户友好指导系统

python3 /path/to/AI-Copyright-Application-Generator/scripts/user_guide.py
  • 功能:交互式菜单系统,简化整个申请流程
  • 特点:智能操作建议、一键式工具调用、实时状态反馈、新手友好指导
  • 集成工具:所有验证和监控工具的统一入口

质量保证工作流程

第一阶段:项目初始化验证

  1. 运行项目诊断工具检查基础环境
  2. 确保所有必需文件和目录完整
  3. 验证配置文件格式正确

第二阶段:需求文档质量检查

  1. 填写需求文档后立即运行质量检查
  2. 根据质量报告优化文档内容
  3. 确保质量分数达到70分以上

第三阶段:生成过程质量监控

  1. 在代码生成过程中定期运行质量监控
  2. 跟踪生成进度和代码质量指标
  3. 根据预测成功率调整生成策略

第四阶段:最终质量验证

  1. 完成所有材料生成后进行全面质量检查
  2. 确保申请成功率预测达到85%以上
  3. 生成完整的质量验证报告

高级功能

批量项目管理

# 为多个软件项目创建独立的软著申请材料
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py project-a
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py project-b
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py project-c

版本控制

# 在项目目录中使用Git管理版本
git init
git add .
git commit -m "软著申请材料v1.0"

自定义技术栈

在ai-copyright-config.json中配置不同的技术组合:

  • React + Node.js
  • Vue.js + Spring Boot
  • Angular + Python Flask
  • 小程序 + Java后端

源代码文档生成脚本详解 📄

系统提供了完整的自动化脚本体系,将生成的源代码转换为软著申请所需的文档格式:

新版跨平台合并脚本(推荐)

前端代码合并

python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_frontend_simple.py
  • 功能:将所有前端HTML文件完整拼接成单一文档
  • 跨平台:支持Windows/Linux/macOS
  • 输出output_docs/前端源代码.txt
  • 特点:零token消耗,纯本地处理,保持源代码完整性

后端代码合并

python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_backend_simple.py
  • 功能:多语言源代码合并工具
  • 支持技术栈:Java、Python、Node.js、PHP、C#、C++、Go、Ruby、Rust、Kotlin、Swift
  • 输出output_docs/后端源代码.txt
  • 智能处理:按文件类型自动排序和分类

数据库代码合并

python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_database_simple.py
  • 功能:SQL文件合并和分析工具
  • 分析:自动统计SQL语句类型和数据库复杂度
  • 输出output_docs/数据库源代码.txt

一键合并所有代码

python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_all_simple.py
  • 功能:执行所有合并脚本并生成详细报告
  • 输出:完整的申请材料包和汇总报告

原版生成脚本(兼容保留)

# 原有脚本仍然可用
python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_frontend_simple.py
python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_backend_simple.py
python3 /path/to/AI-Copyright-Application-Generator/scripts/generators/merge_all_simple.py

脚本优势对比

  • 新版合并脚本

    • ✅ 跨平台兼容(Windows/Linux/macOS)
    • ✅ 完整源代码保留,无分批或压缩
    • ✅ 直接可用于软著申请提交
    • ✅ 多技术栈支持
  • 原版生成脚本

    • ✅ 分批生成,适用于AI对话
    • ✅ 避免token超限问题
    • ✅ 与现有工作流程兼容

相关文档参考


提示:建议首次使用时选择一个相对简单的软件项目进行测试,熟悉整个流程后再处理复杂项目的软著申请材料生成。