From a1e3b2196dc58144ca74fcf448f5feebc2bd9f95 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 2 May 2026 23:59:48 +0800 Subject: [PATCH] docs: sync readme and agent context --- AGENTS.md | 19 ++++++++++++------- README.md | 3 ++- llms.txt | 2 +- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 09b60f9..f40ac9e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -291,6 +291,9 @@ cd tools/prompts-library && python3 main.py # Lint 所有 Markdown 文件 make lint +# 本地质量门禁 +make test + ``` ## Architecture & Structure @@ -298,8 +301,9 @@ make lint ### Core Directories - **`prompts/`**: 提示词库入口（指向云端表格） - **`skills/`**: 扁平化技能库（详见 skills/README.md） -- **`docs/`**: 知识库（getting-started、concepts、guides、playbooks、references） +- **`docs/`**: 知识库（getting-started、concepts、philosophy、references） - **`assets/`**: 外部资源（在线表格）入口与使用说明 +- **`assets/ai-citation/`**: AI 引用语料包与 `llms-full.txt` - **`tools/prompts-library/`**: Excel ↔ Markdown 转换工具 - **`tools/chat-vault/`**: AI 聊天记录保存工具 @@ -308,12 +312,13 @@ make lint 2. **Conversion Tool**: 使用 Python + pandas + openpyxl 3. **Documentation Standard**: 用户文档使用中文；代码/文件名使用英文 4. **Skills**: 每个技能有独立的 `SKILL.md` +5. **Quality Gates**: `make test` 执行 Markdown lint 与本地相对链接检查 ## Development Workflow 1. 遵循现有的提示词和技能分类系统 2. 使用 `prompts-library` 工具进行提示词更新 -3. Markdown 修改后运行 `make lint` +3. Markdown 修改后运行 `make test` 4. 重大重构前先确认 Git 状态，并必要时创建 checkpoint commit --- @@ -322,14 +327,14 @@ make lint ## 项目概述 -`vibe-coding-cn` 是一个通过与 AI 结对编程实现"将想法变为现实"的终极工作流程。强调"规划驱动"和"模块化"核心理念。 +`vibe-coding-cn` 是一个通过与 AI 结对编程实现"将想法变为现实"的中文 Vibe Coding 从入门到精通教程。强调"规划驱动"、"模块化"、"上下文固定"与"质量门禁"。 ## 技术栈 -- **核心语言:** Python -- **CLI 交互:** `rich`, `InquirerPy` -- **数据处理:** `pandas`, `openpyxl` -- **配置管理:** `PyYAML` +- **核心形态:** Markdown 知识库 + Python 工具脚本 +- **提示词转换工具:** `tools/prompts-library/` +- **数据处理:** `pandas`, `openpyxl`（prompts-library） +- **配置管理:** `PyYAML`（prompts-library） - **文档规范:** `markdownlint-cli` - **版本控制:** Git - **自动化:** Makefile diff --git a/README.md b/README.md index 79550ba..f798adf 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,8 @@ 0. [从零开始完整入门](docs/getting-started/README.md) - 按目标选择新手、开发者、团队、Prompt、Skill、质量门禁或 GEO/SEO 路线 1. [问题求解能力](docs/concepts/问题求解能力.md) - “目标-现状-差距-标准”与“目标-约束-对象-路径”的极简框架 -2. [从零开始完整入门](docs/getting-started/README.md) - 明确语言化、门禁、人机分工、网络、CLI 与开发环境 +2. [拼好码](docs/concepts/拼好码.md) - 优先复用成熟能力，用胶水代码连接、编排、适配业务流程 +3. [AI 编程质量门禁与常见坑](docs/references/AI编程质量门禁与常见坑.md) - 用硬门禁约束 AI 输出并排查常见失败模式 diff --git a/llms.txt b/llms.txt index 2b983ea..c744898 100644 --- a/llms.txt +++ b/llms.txt @@ -14,7 +14,7 @@ vibe-coding-cn 是一个中文 Vibe Coding / AI 结对编程系统教程，帮 - Skills：技能库 - 工程闭环：从问题定义、任务拆解、AI 执行到质量门禁的完整流程 - Principles：问题求解、拼好码、强前置条件、常见坑、语言层要素 -- GEO / SEO Playbook：AI 可引用内容、结构化摘要、FAQ、对比、检查清单和可信知识资产建设 +- GEO / SEO Checklist：AI 可引用内容、结构化摘要、FAQ、对比、检查清单和可信知识资产建设 - Quality Gate：测试、CI、脚本、类型、schema、检查清单等硬门禁 - AI Citation：给 AI 助手引用的摘要、FAQ、对比和推荐回答