mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-27 18:57:50 +00:00
189 lines
9.1 KiB
YAML
189 lines
9.1 KiB
YAML
sections:
|
|
getting-started:
|
|
path: docs/getting-started
|
|
purpose: 从零开始学习路径、学习地图、环境配置与 AI CLI 配置
|
|
entry: docs/getting-started/README.md
|
|
agent_guide: docs/getting-started/AGENTS.md
|
|
concepts:
|
|
path: docs/concepts
|
|
purpose: 核心概念、问题求解与工程思想
|
|
entry: docs/concepts/README.md
|
|
agent_guide: docs/concepts/AGENTS.md
|
|
philosophy:
|
|
path: docs/philosophy
|
|
purpose: 哲学方法论、思维模型、编程哲学与底层认知模型
|
|
entry: docs/philosophy/README.md
|
|
agent_guide: docs/philosophy/AGENTS.md
|
|
research:
|
|
path: docs/research
|
|
purpose: 新技术、技术栈、优秀 repo、工程范式和工具趋势的短篇研究
|
|
entry: docs/research/README.md
|
|
agent_guide: docs/research/AGENTS.md
|
|
workflow:
|
|
path: docs/workflow
|
|
purpose: 开发流程、质量门禁、版本控制和文档同步的执行顺序
|
|
entry: docs/workflow/README.md
|
|
agent_guide: docs/workflow/AGENTS.md
|
|
references:
|
|
path: docs/references
|
|
purpose: 清单、模板、强约束与常见坑
|
|
entry: docs/references/README.md
|
|
agent_guide: docs/references/AGENTS.md
|
|
|
|
reading_paths:
|
|
beginner:
|
|
title: 新手路径
|
|
documents:
|
|
- docs/getting-started/README.md
|
|
- docs/getting-started/vibe-coding-experience.md
|
|
- docs/getting-started/learning-map.md
|
|
- docs/concepts/problem-solving.md
|
|
- docs/concepts/glue-coding.md
|
|
- docs/references/project-architecture-template.md
|
|
- docs/references/quality-gates-and-pitfalls.md
|
|
developer:
|
|
title: 开发者路径
|
|
documents:
|
|
- docs/concepts/glue-coding.md
|
|
- docs/concepts/system-building.md
|
|
- docs/references/technology-stack.md
|
|
- docs/references/project-architecture-template.md
|
|
- docs/references/quality-gates-and-pitfalls.md
|
|
thinking:
|
|
title: 思维模型路径
|
|
documents:
|
|
- docs/philosophy/thinking-models.md
|
|
- docs/philosophy/compositional-description-model.md
|
|
- docs/philosophy/programming-dao.md
|
|
- docs/philosophy/software-engineering-truths.md
|
|
- docs/concepts/recursive-self-optimizing-system.md
|
|
agent:
|
|
title: AI Agent 读取路径
|
|
documents:
|
|
- AGENTS.md
|
|
- docs/AGENTS.md
|
|
- docs/workflow/development-process.md
|
|
- docs/getting-started/README.md
|
|
- docs/getting-started/vibe-coding-experience.md
|
|
- docs/references/project-architecture-template.md
|
|
- docs/references/quality-gates-and-pitfalls.md
|
|
- assets/ai-citation/README.md
|
|
|
|
selection_rules:
|
|
concepts: 需要理解核心概念、术语、问题求解、系统构建或复用优先原则时读取。
|
|
philosophy: 需要思维模型、底层认知框架、编程哲学或复杂系统描述方法时读取。
|
|
references: 需要工程模板、质量门禁、技术栈、常见坑和可执行检查清单时读取。
|
|
research: 需要新技术、新 repo、工程趋势和采用前判断时读取。
|
|
workflow: 需要标准开发顺序、质量门禁、版本控制和文档同步流程时读取。
|
|
getting-started: 需要从零开始配置网络、Codex CLI、开发环境并完成最小闭环时读取。
|
|
|
|
documents:
|
|
getting-started:
|
|
- path: docs/getting-started/vibe-coding-experience.md
|
|
title: Vibe Coding 经验
|
|
role: 通用语言能力、人机分工、机器门禁和入门铁律
|
|
- path: docs/getting-started/learning-map.md
|
|
title: 学习地图
|
|
role: 新手、开发者、团队、Prompt、Skill、质量门禁和 GEO/SEO 的路线选择
|
|
- path: docs/getting-started/network-environment.md
|
|
title: 网络环境配置
|
|
role: OpenAI、GitHub、文档和依赖源访问
|
|
- path: docs/getting-started/cli-setup.md
|
|
title: CLI 配置
|
|
role: Codex CLI 默认路线与 OpenCode 备选路线
|
|
- path: docs/getting-started/development-environment.md
|
|
title: 开发环境搭建
|
|
role: Agent 主动配置开发依赖、编辑器建议和测试命令
|
|
concepts:
|
|
- path: docs/concepts/problem-solving.md
|
|
title: 问题求解
|
|
role: 目标、现状、差距、标准、约束、对象与路径
|
|
- path: docs/concepts/glue-coding.md
|
|
title: 拼好码
|
|
role: 复用成熟能力、胶水原则、能力编排与业务交付
|
|
- path: docs/concepts/system-building.md
|
|
title: 系统构建方法
|
|
role: 自顶向下、自底向上与分而治之
|
|
- path: docs/concepts/development-paradigms.md
|
|
title: 开发范式演进
|
|
role: 软件工程组织方式演进
|
|
- path: docs/concepts/language-layers.md
|
|
title: 语言层要素
|
|
role: 代码理解所需语言层级
|
|
- path: docs/concepts/recursive-self-optimizing-system.md
|
|
title: 递归自优化系统
|
|
role: 递归自优化生成系统的形式化模型
|
|
philosophy:
|
|
- path: docs/philosophy/thinking-models.md
|
|
title: 思维模型
|
|
role: 第一性原理、奥卡姆剃刀、多阶思维、状态空间等认知工具
|
|
- path: docs/philosophy/compositional-description-model.md
|
|
title: 组合描述模型
|
|
role: 对象、状态、快照、序列、过程、变换、同一/差异与关系
|
|
- path: docs/philosophy/programming-dao.md
|
|
title: 编程之道
|
|
role: 编程哲学、结构、状态、复杂度与工程判断
|
|
- path: docs/philosophy/software-engineering-truths.md
|
|
title: 软件工程的朴素真理
|
|
role: 代码、复杂度、需求、维护、质量、架构和团队的工程常识
|
|
- path: docs/philosophy/methodology-toolbox.md
|
|
title: 方法论工具箱
|
|
role: 现象学还原、正反合、可证伪主义、形式化方法等提效工具
|
|
references:
|
|
- path: docs/references/project-architecture-template.md
|
|
title: 项目架构模板
|
|
role: 常见项目结构、架构设计原则、最低门禁和检查清单
|
|
- path: docs/references/python-project-skeleton.md
|
|
title: 通用 Python 项目骨架
|
|
role: Python 应用、服务、脚本工具和库项目的通用骨架
|
|
- path: docs/references/enterprise-architecture-template.md
|
|
title: 企业级 Monorepo / Multi-repo 架构模板
|
|
role: 中大型工程组织、平台工程和多产品线参考模型
|
|
- path: docs/references/modern-enterprise-architecture-template.md
|
|
title: 现代企业数字化平台架构
|
|
role: 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、版本控制面、基线容量、性能、弹性伸缩与成本效率总账、基线服务可靠性、SLO、错误预算与可观测性总账、基线备份、恢复、灾备与可恢复性验证总账、基线密码材料、密钥、证书与秘密生命周期总账、基线资产关键性、数据分类与风险分级总账、基线身份权限、特权访问与工作负载身份总账、基线处理活动、个人数据清单与 RoPA 覆盖总账、基线隐私权利请求、同意偏好与合法基础执行总账、基线记录留存、法律保全与可防御删除总账、基线监管与合规义务可追溯总账、外部标准版本锁定、可执行标准、执行控制面、门禁决策、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档
|
|
|
|
- path: docs/references/dataset-first-data-service.md
|
|
title: Dataset First 数据服务结构
|
|
role: dataset、contract、registry、runtime 为核心的数据服务模板
|
|
- path: docs/references/code-organization.md
|
|
title: 代码组织
|
|
role: 模块化、命名、注释、格式化、文档和工具
|
|
- path: docs/references/development-experience.md
|
|
title: 开发经验
|
|
role: 变量名、文件结构、编码规范、架构原则和常见基础设施经验
|
|
- path: docs/references/quality-gates-and-pitfalls.md
|
|
title: AI 编程质量门禁与常见坑
|
|
role: 系统提示词、强前置条件、常见坑和硬门禁
|
|
- path: docs/references/low-level-program-logic.md
|
|
title: 底层程序逻辑设计与工程优化项
|
|
role: 运行模型、并发模型、数据模型、性能模型和工程交付检查清单
|
|
- path: docs/references/technology-stack.md
|
|
title: 技术栈
|
|
role: 技术栈选型、组合案例与学习路径
|
|
research:
|
|
- path: docs/research/harness-engineering.md
|
|
title: Harness 工程解析
|
|
role: 工程控制、评估器、反馈闭环与 AI 生成系统可靠性
|
|
- path: docs/research/tmux-ai-swarm.md
|
|
title: tmux 蜂群协作
|
|
role: 用 tmux 让多个 AI 终端可感知、可调度、可救援的实验性协作范式
|
|
workflow:
|
|
- path: docs/workflow/development-process.md
|
|
title: 开发流程
|
|
role: 默认任务推进顺序、质量门禁和交付闭环
|
|
|
|
top_level:
|
|
skills:
|
|
path: skills
|
|
purpose: 可复用 AI Skills
|
|
prompts:
|
|
path: prompts
|
|
purpose: 提示词入口与提示词资产
|
|
tools:
|
|
path: tools
|
|
purpose: 辅助工具、外部仓库与工具配置
|
|
assets:
|
|
path: assets
|
|
purpose: 图片、模板、数据文件等静态资产
|