项目描述文档维护
每次提交新功能后,检查是否需要更新项目描述文档。
两个文件的定位
README.md(开发者视角)
目标读者:开发者、技术决策者、开源贡献者
核心内容:
- •项目简介和核心价值
- •系统架构图
- •功能流程图(mermaid)
- •技术栈说明
- •部署指南(Docker/本地开发)
- •配置说明
- •项目结构
- •API 文档链接
- •常用命令
写作风格:
- •技术性、准确性优先
- •结构化、层次分明
- •代码示例清晰
- •配置参数详尽
更新触发条件:
- •新增/删除核心功能模块
- •修改系统架构
- •新增 Agent 类型
- •修改部署方式或配置项
- •新增重要 API 端点
- •修改项目目录结构
- •更新技术栈版本
frontend/app/page.tsx(用户视角)
目标读者:潜在用户、企业决策者、产品经理
核心内容:
- •Hero 区域:核心价值主张
- •转化流程:匿名用户 → 企业微信推送 → 直连客户
- •Agent 类型展示:四种 Agent 的功能亮点
- •智能记忆系统:用户画像、事实记忆、知识图谱
- •快速配置:3 步即可上线
- •更多能力:工具生态展示
- •CTA 区域:号召行动
写作风格:
- •营销性、说服力优先
- •用户利益驱动
- •简洁有力的文案
- •视觉冲击力(动画、渐变、卡片)
更新触发条件:
- •核心价值主张变化
- •新增用户可感知的重要功能
- •Agent 类型变化
- •转化流程优化
- •定价策略变化
- •品牌文案调整
检查清单
README.md 检查项
| 区域 | 检查内容 |
|---|---|
| 项目简介 | 是否反映最新的核心功能? |
| 架构图 | 是否包含新增的服务组件? |
| 功能流程图 | 是否覆盖新的用户路径? |
| Agent 类型 | 是否包含所有支持的类型? |
| 技术栈 | 版本号是否正确? |
| 部署指南 | 步骤是否完整? |
| 配置说明 | 新配置项是否添加? |
| 项目结构 | 目录是否反映当前状态? |
page.tsx 检查项
| 区域 | 检查内容 |
|---|---|
| Hero 文案 | 是否突出最新卖点? |
| 转化流程 | 步骤是否准确? |
| Agent 卡片 | 是否展示所有类型? |
| 记忆系统 | 功能描述是否更新? |
| 快速配置 | 步骤是否与实际一致? |
| 更多能力 | 是否包含新增功能? |
| CTA 按钮 | 链接是否正确? |
更新原则
README.md
- •准确性:所有技术细节必须与代码一致
- •完整性:覆盖所有核心功能和配置
- •可操作性:部署步骤必须可执行
- •结构化:使用表格、代码块、流程图
- •版本同步:技术栈版本与 package.json/pyproject.toml 一致
page.tsx
- •价值驱动:突出用户能获得什么
- •转化导向:引导用户点击 CTA
- •视觉吸引:保持动画和设计一致性
- •简洁有力:每个区块一个核心信息
- •移动优先:确保移动端展示正确
常见术语对照
| 旧术语 | 新术语 | 说明 |
|---|---|---|
| 一站式引导 | 快速配置 | v0.1.14 更新 |
| 工作空间 | 配置 | v0.1.14 更新 |
| Quick Setup | 快速配置 | 统一中文命名 |
输出格式
检查完成后,输出以下格式的报告:
code
## 项目描述文档检查报告 ### 本次功能变更 - 新增了 xxx 功能 - 修改了 xxx 模块 ### README.md 更新情况 - ✅ 无需更新 - ⚠️ 需要更新 - [ ] 在「xxx」章节添加 xxx 说明 - [ ] 更新「项目结构」中的 xxx 目录 ### page.tsx 更新情况 - ✅ 无需更新 - ⚠️ 需要更新 - [ ] 在「Agent 类型」区域添加 xxx 卡片 - [ ] 更新「快速配置」步骤描述
注意事项
- •避免过度更新:只有用户可感知的重要变更才需要更新 page.tsx
- •保持一致性:两个文件中的同一功能描述应一致
- •测试链接:确保所有链接和按钮指向正确
- •版本记录:重大更新应同步更新 CHANGELOG.md