01-快速开始.md 3.4 KB

01-快速开始 - AI驱动软件著作权申请材料生成系统

📚 学习路径第1步 | ⚡ 目标:5分钟内创建您的第一个软著申请材料项目

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

环境检查 (30秒)

python3 --version  # 确保 Python 3.6+

如环境未配置,请先查看 02-安装指南.md

四步快速上手

1️⃣ 创建项目 (1分钟)

推荐方式:交互式创建(支持UI风格选择)

# 在任意目录创建(推荐)
cd /your/workspace
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py "我的软著项目"

# 或在工程目录内创建
cd AI-Copyright-Application-Generator  
python3 scripts/init/init_project.py "我的软著项目"

快速复制方式

cp -r "AI-Copyright-Application-Generator" "我的软著项目"
cd "我的软著项目"

提示:初始化脚本会引导您选择UI设计风格(企业商务/暗黑科技/极简主义)并自动配置项目。

2️⃣ 配置基本信息 (2分钟)

编辑 ai-copyright-config.json:

{
  "title": "智能库存管理系统",
  "short_title": "库存系统", 
  "front": "React",
  "backend": "Spring Boot",
  "requirements_description": "requires_docs/需求文档.md"
}

3️⃣ 填写需求文档 (2分钟)

编辑 requires_docs/需求文档.md,重点填写:

  • 系统概述:这个软件是做什么的
  • 核心功能:3-5个主要功能模块
  • 特色创新:与同类软件的区别 ⭐️关键

💡 参考示例:系统提供4种模式的需求文档示例

  • 需求文档_示例_极简模式.md - 50-200字基本想法
  • 需求文档_示例_简要模式.md - 500-1000字功能框架
  • 需求文档_示例_详细模式.md - 2000-5000字完整PRD
  • 需求文档_示例_高规格模式.md - 5000-10000字企业级PRD

4️⃣ 开始生成材料 (30秒)

# 验证AI提示词完整
ls system_prompts/

# 准备就绪!现在按照六阶段优化流程生成材料

接下来做什么?

🎯 生成软著材料:参考 03-使用说明.md 的详细六阶段优化流程

📝 最终输出材料

  • 软件著作权登记信息表
  • 前后端源代码文档 (各60+页)
  • 用户手册
  • 数据库设计文档

快速测试示例

想立即体验?运行这个测试:

python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py test-demo
cd test-demo
# 编辑需求文档,填入任意软件项目信息
# 然后按照使用说明执行六阶段优化流程

💡 进阶技巧

配置全局命令(可选)

如果经常使用,可以配置全局命令:

# 方法1:添加到PATH
export PATH="$PATH:/path/to/AI-Copyright-Application-Generator"

# 方法2:创建软链接
sudo ln -s /path/to/AI-Copyright-Application-Generator/create-copyright-project /usr/local/bin/

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

配置文件重命名说明

  • 新配置文件名ai-copyright-config.json(避免与其他项目的config.json冲突)
  • 原配置文件名config.json(已废弃)
  • 自动兼容:所有文档和脚本已同步更新

下一步:查看 03-使用说明.md 了解完整的材料生成流程