Skip to content

开发者活文档导航 ​

本目录描述当前代码的稳定结构与开发约定,目标是让开发者和 AI 在修改前快速找到正确入口。代码始终是最终事实来源;当文档与代码不一致时,以根目录 AGENTS.md 和相关源码为准,并在同一任务中同步文档。

浏览器查看:在仓库根目录进入 website/ 后运行 npm run docs:dev,打开 http://127.0.0.1:6173/dev/living/(与现有用户文档同一站点,不另开端口)。详细说明见 文档站使用。

推荐阅读顺序 ​

任务先读再读
了解全局结构structure-overview.mdarchitecture.md、module-map.md
按功能找模块卡feature-map.md图片引导章节 → desktop / core / 插件
按周期补齐活文档roadmap.md先 C0 结构可见,再 C1–C3
检索凡修任务凡修任务清单凡修业务任务域、文档站 /business/
按功能定位模块模块总索引对应模块卡入口与测试候选
分析公共能力修改影响反向依赖uv run python -m tools.living_docs impact
新增模块或同步结构说明module-maintenance.md模块模板
标准/重大改动定位对应模块卡AGENTS.md 相关强制规则

文档职责 ​

  • structure-overview.md:包分层、主链路与找卡入口(薄总览)。
  • feature-map.md:用户功能 / 图片引导 → 活文档卡与 core/插件映射。
  • architecture.md:技术栈、启动链路、包职责、依赖边界。
  • module-map.md:按包/能力划分的模块地图(不是 Vue 业务域)。
  • roadmap.md:活文档 C0–C3 周期计划、完成定义与微调开关。
  • module-maintenance.md:人工与自动区协议、检查命令、分析边界。
  • modules/<domain>/:模块卡;自动区提供源码链路。
  • generated/:总索引、反向依赖、待确认清单、侧栏数据、凡修任务清单(由 generate 维护)。

域入口 ​

桌面中控 · 核心运行时 · 核心配置 · 公共插件 · 凡修业务 · 模拟器适配 · 构建发布 · 文档站

尚未核对的内容见 待确认清单。旧版重构计划文档仍在 docs/*-plan.md,默认仅作历史参考,不以它们为现状真相源。

与需求门控的关系 ​

  • 问答 / 微改 / 快路径:不强制输出定位摘要。
  • 标准开发与重大/架构:在理解或方案阶段给出定位摘要(见 AGENTS.md「开发者活文档」),实施后按需 impact + 同步模块卡 + generate/check。
  • 不把规格默认写入 requirements.md / design.md / tasks.md;跨会话进度仍用 docs/requirements/board.json。