42 lines
3.1 KiB
Markdown
42 lines
3.1 KiB
Markdown
# 项目文档导航
|
||
|
||
## 一句话定位
|
||
|
||
Skelet 是一个面向 AI coding 开发者、独立开发者和小团队的开源项目骨架导航与评测网站，用于解决“从哪个稳定骨架开始新项目更省 token、更省时间、更不容易跑偏”的决策问题，第一版先完成“浏览分类 -> 筛选骨架 -> 查看详情与评分 -> 形成选型判断”的 MVP 闭环。
|
||
|
||
## 文档导航
|
||
|
||
- [`../AGENTS.md`](../AGENTS.md)：Codex / 通用 AI coding agent 的仓库级入口。
|
||
- [`../CLAUDE.md`](../CLAUDE.md)：Claude Code 的薄入口，具体规则以 `AGENTS.md` 为准。
|
||
- [`../tasks.md`](../tasks.md)：根目录任务入口，指向 `06-tasks.md`。
|
||
- [`../progress.md`](../progress.md)：执行历史流水，只追加记录任务执行、验证、阻塞和决策。
|
||
- [AI 开发入口](00-ai-start-here.md)：agent 每次开始工作的入口、阅读顺序和任务领取规则。
|
||
- [项目愿景](01-vision.md)：为什么做、为谁做、产品原则、非目标。
|
||
- [需求](02-requirements.md)：MVP 要什么、怎么算达成。
|
||
- [技术栈](03-tech-stack.md)：Wagtail / Django / Python / SQLite 等技术选型和运行命令。
|
||
- [架构设计](04-architecture.md)：系统结构、模块职责、数据模型、关键风险和开发顺序。
|
||
- [编码规则](05-coding-rules.md)：AI 写代码前必须遵守的硬约束。
|
||
- [任务看板](06-tasks.md)：按依赖拆分的小任务，agent 每轮只做一个。
|
||
- [API 合约](api.md)：MVP 不提供公开 API，记录 Wagtail 路由、后续 API 边界。
|
||
- [路由与页面结构](routes.md)：前台页面、后台路由、页面职责和组件归属。
|
||
- [当前实现状态](current-state.md)：当前仓库现实状态、可运行命令和下一步任务。
|
||
- [收尾检查清单](clean-state-checklist.md)：会话结束前逐项检查，保证下一轮无需人工修复即可继续。
|
||
- [已有项目接入清单](adoption-checklist.md)：已有代码库接入 harness 文档时使用，本项目当前是空项目初始化。
|
||
- [方法对照表](method-map.md)：失败模式与首要修复工件。
|
||
- [评审评分表](evaluator-rubric.md)：单次会话输出质量评审。
|
||
- [质量文档](quality-document.md)：代码库长期健康度追踪。
|
||
- [`../init.sh`](../init.sh) / [`../init.ps1`](../init.ps1)：标准启动与验证入口脚本；生产代码初始化后再替换真实命令。
|
||
|
||
## 任务 / 进度 / 当前状态
|
||
|
||
- `06-tasks.md` 维护任务看板：任务 ID、依赖、验收要点和状态。
|
||
- `../progress.md` 维护执行进度：每轮实际做了什么、跑了什么验证、遇到什么阻塞、做了什么决策。
|
||
- `current-state.md` 维护当前快照：当前目录、当前可运行命令、已完成任务摘要和下一个可领取任务。
|
||
|
||
## 维护原则
|
||
|
||
- 需求变化先改 `02-requirements.md`，再改代码。
|
||
- 技术方案变化先改 `03-tech-stack.md` 和 `04-architecture.md`，再改代码。
|
||
- 代码现实变化后同步 `current-state.md` 和 `06-tasks.md`，执行过程追加到 `../progress.md`。
|
||
- MVP 范围外的商业化、会员、用户投稿、复杂搜索只进入 Backlog，不提前实现。
|