Update documentation from Claude Code

This commit is contained in:
QiuSW
2026-07-06 11:32:35 +08:00
parent fae7fda88c
commit 53d6430ea0
22 changed files with 345 additions and 423 deletions
+19 -26
View File
@@ -269,20 +269,21 @@ workflow automation open source
## 五、AI Coding 友好度评估
每个候选项目都要按以下维度评分:
评分维度的**唯一权威定义**在 [`../docs/04-architecture.md`](../docs/04-architecture.md):6 个 0-5 分项,总分由分项计算、不单独录入。本文不另行维护维度清单。评审时对应的检查问题:
| 维度 | 评分问题 |
| 维度(定义见架构文档) | 评分问题 |
| --- | --- |
| 目录结构 | agent 能否快速理解入口、模块和边界? |
| 文档完整度 | 是否有清楚的启动、测试、部署说明? |
| 测试可用性 | 是否能用一条命令跑基础测试? |
| 示例模块 | 是否有一个完整功能供 agent 模仿? |
| 依赖克制度 | 是否需要大量外部账号或复杂服务才能运行? |
| 增量开发难度 | 新增功能是否有清晰落点? |
| 任务切片友好度 | 是否适合一轮只做一个小任务? |
| 增量开发难度 | 新增功能是否有清晰落点?是否适合一轮只做一个小任务?(原"任务切片友好度"已并入本维度) |
评分不是只给总分,还要写一句评语:为什么适合 AI coding,为什么不适合。
**时间成本提示**:每个项目按完整收录流程(clone、跑起来、评分、写适合/不适合)需要 2-4 小时。可先用 15 分钟粗筛(license、最近提交、README 质量)淘汰明显不合格者,只对通过粗筛的项目做完整评测。
## 六、收录流程
推荐流程:
@@ -303,34 +304,34 @@ MVP 阶段可以先人工维护,不做自动抓取。
## 七、首批内容建议
第一批不要追求全行业覆盖,建议先做 4 个高需求场景:
第一批不要追求全行业覆盖。**首批只做 2 个场景**(与 `business-plan-v1.md` 里程碑 M2 和 `competitor-analysis.md` 一致):
1. SaaS
2. 管理后台
3. API 服务
4. 内容站 / CMS
2. 内容站 / CMS
每个场景先收录 8-15 个项目,保证详情页质量,而不是快速堆数量。
每个场景收录约 10 个项目,保证详情页质量,而不是快速堆数量。管理后台和 API 服务在 M3(SEO 验证)闸门通过后作为第二批扩展。
第一批建议技术栈覆盖:
首批技术栈覆盖以两个场景的主流生态为准:
- Python:Django、FastAPI、Wagtail
- TypeScript:Next.js、NestJS
- TypeScript:Next.js
- PHP:Laravel
- Go:API 服务
- Java:Spring Boot
第二批扩展时再覆盖:NestJS、Go API 服务、Spring Boot。
## 八、更新节奏
建议节奏:
按单人投入校准(与 `content-strategy.md` 发布节奏一致):
| 周期 | 工作 |
| --- | --- |
| 每周 | 新增 3-5 个候选项目,更新维护状态。 |
| 每月 | 发布 2-4 篇对比/评测文章。 |
| 每周 | 新增 2-3 个候选项目,更新维护状态。 |
| 每两周 | 发布 1 篇对比/评测文章。 |
| 每季度 | 复查高流量项目评分和推荐结论。 |
| 每半年 | 清理长期无人维护项目,标记 archived / stale。 |
M3 闸门通过前,内容库封顶 20 个项目 + 12 篇文章(见 `business-plan-v1.md`)。
## 九、数据字段建议
后续录入 Wagtail 时,每个项目至少包含:
@@ -363,14 +364,6 @@ MVP 阶段可以先人工维护,不做自动抓取。
- 不收录无法明确 license 的项目作为重点推荐。
- 不为了数量牺牲可信度。
## 十一、下一步任务建议
## 十一、下一步任务
可以同步到 `docs/06-tasks.md` 的后续任务:
```text
T-105 建立首批骨架项目候选清单
T-106 完成 SaaS 场景 10 个项目初评
T-107 完成管理后台场景 10 个项目初评
T-108 完成 API 服务场景 10 个项目初评
T-109 完成内容站 / CMS 场景 10 个项目初评
```
首批内容库建设任务**已收进 [`../docs/06-tasks.md`](../docs/06-tasks.md) 的 Backlog**(任务状态以看板为唯一权威,本文不再单独维护任务清单):建立候选清单,完成 SaaS、内容站/CMS 两个场景各 10 个项目初评;管理后台和 API 服务场景在 M3 验证通过后再排期。