跳转至

文档目录

本目录包含 EasyKiConverter 项目的所有文档。

文档组织

文档按照目标读者分为三类：

面向用户 (user/)

这类文档的目标是让用户知道这是什么以及如何使用它。

面向开发者 (developer/)

这类文档的目标是让其他开发者（或未来的你）能够理解项目、参与贡献和进行维护。

面向项目决策 (project/)

这类文档记录了项目的演进过程和未来方向，帮助团队做出正确的战略决策。

文档语言

所有文档都提供中英文双语版本： - 中文文档使用中文文件名 - 英文文档使用英文文件名（带 _en 后缀）

如何使用文档

如果您是用户

  1. 从 快速开始 开始
  2. 阅读 用户手册 了解详细功能
  3. 查看 常见问题 解决遇到的问题

如果您是开发者

  1. 阅读 构建指南 了解如何构建项目
  2. 查看 架构文档 理解项目架构
  3. 阅读 贡献指南 了解如何贡献代码

如果您想了解项目规划

  1. 查看 项目路线图 了解未来方向
  2. 阅读 架构决策记录 了解技术决策

文档原则

  • 文档即代码：文档和代码放在同一个仓库中，使用 Markdown 等纯文本格式
  • 保持更新：过时的文档比没有文档更糟糕
  • 为读者而写：在写任何文档之前，先想清楚你的读者是谁

贡献文档

如果您想改进文档：

  1. 确保文档与代码保持一致
  2. 提供清晰的示例
  3. 保持中英文双语版本同步
  4. 提交 Pull Request

相关资源