| 1 | # Codewhale 简体中文文档阅读指南 |
| 2 | |
| 3 | > 这里是简体中文用户阅读 Codewhale 文档的入口。英文原版文档在文档根目录 [`docs/`](../)下。 |
| 4 | > 本文档按经验水平组织阅读路径，并跟踪各文档的翻译状态。 |
| 5 | > 下文建议仅表文档维护者本人观点，与 Codewhale 官方立场无关 |
| 6 | |
| 7 | --- |
| 8 | |
| 9 | ## 一、零基础（完全没接触过 harness ，甚至对 AI 编程毫无概念） |
| 10 | |
| 11 | 从零开始，先弄懂"它是什么、装在哪儿、怎么跑起来"。 |
| 12 | |
| 13 | 1. [WINDOWS_BEGINNER.md](WINDOWS_BEGINNER.md) —— Windows 用户上手指南，完全零基础者可阅读此文档以入门 |
| 14 | 2. [HarmonyOS.md](../HarmonyOS.md) —— 鸿蒙设备安装说明，鸿蒙系统用户请重点关注 |
| 15 | 3. [INSTALL.md](../INSTALL.md) —— 所有受支持平台的安装方式与常见安装失败排查 |
| 16 | |
| 17 | ## 二、入门用户（已经装好程序、但仍然对 harness 不够了解） |
| 18 | |
| 19 | 阅读以下文档，能够帮助您快速入门，掌握 Codewhale 这个软件的使用方法 |
| 20 | |
| 21 | 1. [GUIDE.md](../GUIDE.md) —— 最基础的入门教程，一个小时就能读完、实践完，适用于所有平台 |
| 22 | 2. [KEYBINDINGS.md](../KEYBINDINGS.md) —— TUI 页面的快捷键列表，在此可以了解到 Codewhale 的食用方法 |
| 23 | 3. [MODES.md](../MODES.md) —— 各个模式的使用说明（强烈建议每个 Codewhale 用户都阅读此项） |
| 24 | 4. [PROVIDERS.md](../PROVIDERS.md) —— 查询您所用的模型的供应商是否在 Codewhale 官方支持的列表之中 |
| 25 | |
| 26 | ## 三、进阶用户（已经有充足了解，追求效率、安全与定制） |
| 27 | |
| 28 | 把 Codewhale 配置成最顺手的样子。 |
| 29 | |
| 30 | 1. [CONFIGURATION.md](../CONFIGURATION.md) —— 完整配置参考（最大的文档，可分章节阅读） |
| 31 | 2. [Fleet](../FLEET.md) —— Fleet 角色与多模型编排 |
| 32 | 3. [MCP.md](../MCP.md) —— MCP 模型上下文协议接入 |
| 33 | 4. [SKILLS.md](../SKILLS.md) —— 技能（skill）的安装、管理与使用 |
| 34 | 5. [SUBAGENTS.md](../SUBAGENTS.md) —— 子智能体（Fleet）机制 |
| 35 | 6. [HOOKS.md](../HOOKS.md) —— 钩子机制与自动化 |
| 36 | 7. [TOOL_SURFACE.md](../TOOL_SURFACE.md) —— 工具面：AI 当前可用的工具契约 |
| 37 | 8. [AGENT_RUNTIME.md](../AGENT_RUNTIME.md) —— Agent 运行时：子智能体、exec 与 Fleet 的关系 |
| 38 | |
| 39 | ## 四、开发者（阅读源码或为 Codewhale 贡献） |
| 40 | |
| 41 | 为 Codewhale 贡献代码或做集成开发。 |
| 42 | |
| 43 | 1. [ARCHITECTURE.md](../ARCHITECTURE.md) —— 架构总览 |
| 44 | 2. [CONTRIBUTING.md](../../CONTRIBUTING.md) —— 贡献指南：如何提交 Issue 与 PR、代码约定与验证门禁 |
| 45 | 3. [CODE_OF_CONDUCT.md](../../.github/CODE_OF_CONDUCT.md) —— 社区行为准则 |
| 46 | 4. [RUNTIME_API.md](../RUNTIME_API.md) —— Runtime API 与集成契约（供集成与二次开发） |
| 47 | 5. [PLUGIN_AUTHORING.md](PLUGIN_AUTHORING.md) —— 从最小 Skills 示例开始编写、审查和启用插件 |
| 48 | |
| 49 | > 我们强烈建议，成为 Codewhale 贡献者之前，您需要具备一定的英语阅读能力。如果您在英语方面较为薄弱，当然可以使用 LLM 来翻译。但是在 LLM 翻译完原文之后，建议您强忍着看不懂外文的不适，即使皱着眉头，也要审查一遍 LLM 翻译后的语义是否与你的原文语义相同。LLM 幻觉是会把事情搞砸的。 |
| 50 | |
| 51 | --- |
| 52 | |
| 53 | ## 翻译状态 |
| 54 | |
| 55 | 若想问询文档的翻译排期与逐篇状态，可在 [issue #5482](https://github.com/Hmbown/CodeWhale/issues/5482) 跟踪。 |
| 56 | |
| 57 | ## 约定 |
| 58 | |
| 59 | - 每个中文译文都放在 `docs/zh_hans/` 下，保留与英文源相同的文件名主干，便于一一对应。 |
| 60 | - 英文文档顶部会放一条语言切换横幅（例如 `> 阅读简体中文版：[zh_hans/INSTALL.md](zh_hans/INSTALL.md)`）。 |
| 61 | - 中文文档回链英文源，并标注 "last synced with English revision" 日期，让过期一目了然。 |
| 62 | - 旧位置的 `.zh-CN.md` 文件保留为重定向占位页，保留一个发布周期后移除。 |
| 63 | |
| 64 | 本文档更新于 2026 年 8 月 18 日 |
| 65 | Last Updated on August 18, 2026 |
| 66 |