diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5c98472 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +本文档记录知识库结构、入口、分类体系和重要内容的变更。 + +## Unreleased + +- 启动标准知识库结构迁移:新增 `docs/`、`metadata/`、`scripts/`、`tools/` 骨架。 diff --git a/assets/datasets/.gitkeep b/assets/datasets/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/assets/datasets/.gitkeep @@ -0,0 +1 @@ + diff --git a/assets/images/.gitkeep b/assets/images/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/assets/images/.gitkeep @@ -0,0 +1 @@ + diff --git a/assets/templates/.gitkeep b/assets/templates/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/assets/templates/.gitkeep @@ -0,0 +1 @@ + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..865ebf1 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,24 @@ +# 知识库总索引 + +> `docs/` 是本仓库的核心知识库入口,承载从入门路径、核心概念、操作指南、可复用流程、参考清单到实战案例的全部文档。 + +## 目录结构 + +| 目录 | 用途 | +|:---|:---| +| [getting-started](./getting-started/) | 从零开始、学习地图、环境配置与默认 AI CLI 路线 | +| [concepts](./concepts/) | Vibe Coding、拼好码、问题求解、语言层、工程范式等核心概念 | +| [guides](./guides/) | 操作型指南 | +| [playbooks](./playbooks/) | 可复用流程、工具使用方法与工作流 | +| [references](./references/) | 清单、模板、强约束、常见坑与审查标准 | +| [case-studies](./case-studies/) | 实战案例与问题记录 | +| [faq.md](./faq.md) | 高频问题 | + +## 推荐入口 + +1. [学习地图](./getting-started/学习地图.md) +2. [问题求解能力](./concepts/问题求解能力.md) +3. [Vibe Coding 经验](./getting-started/Vibe%20Coding%20经验.md) +4. [拼好码](./concepts/拼好码.md) +5. [强前置条件约束](./references/强前置条件约束.md) +6. [GEO 与 SEO 优化方法](./playbooks/GEO与SEO优化方法.md) diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..73050ba --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,19 @@ +# FAQ + +> 本页用于集中回答 Vibe Coding 入门、工具配置、AI 协作、质量门禁和知识库使用中的高频问题。 + +## 应该从哪里开始? + +先阅读 [学习地图](./getting-started/学习地图.md),再按自己的目标选择新手、开发者、团队、Prompt、Skill、Workflow 或 GEO/SEO 路线。 + +## 这个仓库是 Prompt 库吗? + +不是。Prompt 只是其中一层。本仓库同时覆盖 Prompt、Skill、Workflow、Context 和 Quality Gate,目标是形成从入门到精通的 AI 结对编程系统教程。 + +## 默认推荐哪个 AI CLI? + +默认优先使用 [Codex CLI 配置](./getting-started/Codex-CLI配置.md)。OpenCode CLI 作为备选路线保留。 + +## AI 输出如何验收? + +不要只看 AI 的自然语言解释。优先把验收标准转成测试、CI、脚本、类型、schema 或检查清单等硬门禁。 diff --git a/metadata/glossary.yml b/metadata/glossary.yml new file mode 100644 index 0000000..1525f60 --- /dev/null +++ b/metadata/glossary.yml @@ -0,0 +1,22 @@ +terms: + vibe-coding: + zh: Vibe Coding + description: 以自然语言驱动 AI 结对编程,从想法、需求、方案、任务拆解到编码、测试、部署和复盘的工作方式。 + prompt: + zh: 提示词 + description: 面向 AI 的一次性或可复用指令,用于约束任务、输入、输出和验收标准。 + skill: + zh: 技能 + description: 可复用能力单元,通常包含 SKILL.md、参考资料、脚本和资产。 + workflow: + zh: 工作流 + description: 推进复杂任务的步骤化流程,强调状态、产物、验证和复盘。 + context: + zh: 上下文 + description: AI 执行任务所需的目标、约束、历史、文件、规则和当前状态。 + quality-gate: + zh: 质量门禁 + description: 测试、CI、脚本、类型、schema 或检查清单等可强制验证的约束。 + pinhaoma: + zh: 拼好码 + description: 胶水编程的超集,强调优先复用成熟方案,用自研代码连接、编排、适配和表达业务逻辑。 diff --git a/metadata/redirects.yml b/metadata/redirects.yml new file mode 100644 index 0000000..400b5df --- /dev/null +++ b/metadata/redirects.yml @@ -0,0 +1,21 @@ +redirects: + - from: assets/documents/guides/getting-started/ + to: docs/getting-started/ + - from: assets/documents/principles/fundamentals/ + to: docs/concepts/ 或 docs/references/ + - from: assets/documents/principles/philosophy/ + to: docs/concepts/philosophy/ + - from: assets/documents/guides/playbook/ + to: docs/playbooks/ + - from: assets/documents/workflow/ + to: docs/playbooks/workflows/ + - from: assets/documents/case-studies/ + to: docs/case-studies/ + - from: assets/skills/ + to: skills/ + - from: assets/prompt/ + to: prompts/ + - from: assets/repos/ + to: tools/ + - from: assets/config/ + to: tools/config/ diff --git a/metadata/taxonomy.yml b/metadata/taxonomy.yml new file mode 100644 index 0000000..8e5a233 --- /dev/null +++ b/metadata/taxonomy.yml @@ -0,0 +1,33 @@ +sections: + getting-started: + path: docs/getting-started + purpose: 从零开始学习路径、学习地图、环境配置与 AI CLI 配置 + concepts: + path: docs/concepts + purpose: 核心概念、方法论、问题求解与工程思想 + guides: + path: docs/guides + purpose: 操作型指南 + playbooks: + path: docs/playbooks + purpose: 可复用流程、工具实践与工作流 + references: + path: docs/references + purpose: 清单、模板、强约束、常见坑与审查标准 + case-studies: + path: docs/case-studies + purpose: 实战案例与问题记录 + +top_level: + skills: + path: skills + purpose: 可复用 AI Skills + prompts: + path: prompts + purpose: 提示词入口与提示词资产 + tools: + path: tools + purpose: 辅助工具、外部仓库与工具配置 + assets: + path: assets + purpose: 图片、模板、数据文件等静态资产 diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..915493a --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,5 @@ +# scripts + +本目录存放仓库级自动化脚本,例如链接检查、索引生成、taxonomy 校验、备份脚本和迁移辅助脚本。 + +迁移完成后,原 `assets/repos/backups/` 中的备份脚本会归入本目录。 diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000..a594a58 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,10 @@ +# tools + +本目录存放辅助工具、转换器、外部工具镜像和工具配置。 + +迁移完成后: + +- `prompts-library` 归入 `tools/prompts-library/` +- `chat-vault` 归入 `tools/chat-vault/` +- 外部仓库归入 `tools/external/` +- Codex 等配置归入 `tools/config/`