docs: 补全 AI 入口/API/路由/现状文档并对齐一致性
新增(Codex 起草,本次纳入并校对): - AGENTS.md:仓库级 AI 强约束入口 - docs/00-ai-start-here.md:AI 开发入口与导航 - docs/api.md:账号/生词本/进度 API 合约草案 - docs/routes.md:go-app 页面路由与组件归属 - docs/current-state.md:当前实现状态 补充与对齐: - 验证命令补 bash(WSL/Linux 为主,PowerShell 为备):00-ai-start-here、AGENTS - 04-architecture:新增第六节"项目结构(包布局)"+ 3.2 建表 SQL 草案 - docs/README 导航补 06-tasks;CLAUDE 目录树补 AGENTS/scripts/design_mockups - 00-ai-start-here 去除已过时的"需要补齐"段 - 06-tasks:Phase 2/3/4/5 交叉引用 api.md / routes.md / 包布局 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -12,15 +12,19 @@
|
||||
|
||||
## 文档地图(`docs/`)
|
||||
|
||||
三份文档职责分层,按需读对应那份;**不要把技术细节往 vision/requirements 里塞**:
|
||||
文档职责分层,按需读对应那份;**不要把技术细节往 vision/requirements 里塞**:
|
||||
|
||||
| 文档 | 职责(回答什么) | 该查它当… |
|
||||
| --- | --- | --- |
|
||||
| [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md) | **AI 开发入口**:阅读顺序、任务领取、验证命令 | AI coding agent 进入项目的第一站 |
|
||||
| [`docs/README.md`](docs/README.md) | 项目概览与导航 | 想先有个整体印象 |
|
||||
| [`docs/01-vision.md`](docs/01-vision.md) | **为什么 / 为谁 / 产品原则 / 不做什么** | 拿不准取舍方向、判断某需求该不该做 |
|
||||
| [`docs/02-requirements.md`](docs/02-requirements.md) | **要什么 + 怎么算达成**(产品语言,无技术词、含验收标准) | 确认功能范围、优先级、验收判据 |
|
||||
| [`docs/03-tech-stack.md`](docs/03-tech-stack.md) | **用什么**:框架 / 数据库 / UI / 状态管理 / 部署(速查,含待定项) | 想知道某层用哪个技术 |
|
||||
| [`docs/03-tech-stack.md`](docs/03-tech-stack.md) | **用什么**:框架 / 数据库 / UI / 状态管理 / 部署(速查) | 想知道某层用哪个技术 |
|
||||
| [`docs/04-architecture.md`](docs/04-architecture.md) | **怎么搭**:系统结构、职责划分、**数据模型**、技术难点 | 实际写代码、查数据结构与字段 |
|
||||
| [`docs/api.md`](docs/api.md) | **API 合约草案**:账号 / 生词本 / 进度接口 | 写后端 API 或前端 API client 前 |
|
||||
| [`docs/routes.md`](docs/routes.md) | **路由与页面结构**:页面路由、职责、组件归属 | 写 go-app 页面与导航前 |
|
||||
| [`docs/current-state.md`](docs/current-state.md) | **当前实现状态**:仓库现实、当前可做任务 | 判断代码现状和下一步任务 |
|
||||
| [`docs/05-coding-rules.md`](docs/05-coding-rules.md) | **编码规则**:写代码的硬约束与"完成"的定义 | ⚠️ 动手写代码**之前**必读 |
|
||||
| [`docs/06-tasks.md`](docs/06-tasks.md) | **任务看板**(AI 的 Jira):MVP 拆解、依赖、状态 | 决定"这次做什么"时 |
|
||||
|
||||
@@ -47,10 +51,14 @@
|
||||
|
||||
```
|
||||
lingo/
|
||||
├── AGENTS.md # 仓库级 AI 强约束入口(英文)
|
||||
├── CLAUDE.md # 本文件
|
||||
├── docs/ # 规范化项目文档(事实来源)
|
||||
├── notion_docs/ # Notion 原始导出(只读存档)
|
||||
└── family-album-usa/ # 内容素材
|
||||
├── scripts/ # episodes.json 校验/修正脚本
|
||||
├── design_mockups/ # UI 效果稿(HTML/CSS,可迁移参考)
|
||||
├── notion_docs/ # Notion 原始导出(只读存档,git 忽略)
|
||||
├── design_images/ # 第三方设计参考图(git 忽略)
|
||||
└── family-album-usa/ # 内容素材(git 忽略,含大音频)
|
||||
├── episodes.json # 全部课程内容(约 700KB)
|
||||
└── audio/ # 50 个 mp3,命名 u{集}{幕}.mp3,如 u0101.mp3
|
||||
```
|
||||
@@ -63,7 +71,7 @@ lingo/
|
||||
|
||||
```json
|
||||
{
|
||||
"meta": { "totalEpisodes": 26, "totalActs": 50 },
|
||||
"meta": { "totalEpisodes": 26, "totalActs": 78, "audioActs": 49 },
|
||||
"episodes": [
|
||||
{ "id": 1, "title": "46 Linden Street", "titleCn": "林登大街46号",
|
||||
"acts": [
|
||||
@@ -93,7 +101,7 @@ lingo/
|
||||
|
||||
1. **「音频 + 时间戳字幕同步」最小原型**(最难一环,先跑通)
|
||||
2. 课程列表 + 播放页骨架(读 `episodes.json` 渲染)
|
||||
3. 后端账号体系 + 鉴权(JWT 或 session)
|
||||
3. 后端账号体系 + 鉴权(httpOnly Session Cookie)
|
||||
4. 生词本(前端 UI + 后端 API)
|
||||
5. 进度同步
|
||||
6. PWA manifest + Service Worker 离线化
|
||||
|
||||
Reference in New Issue
Block a user