文档编写指南：总览

高质量的文档是 Dora Pocket 项目的灵魂。清晰、准确、一致的文档能够极大地提升“道具”的可用性和开发者的使用体验。

核心哲学

• 用户中心: 始终站在使用者的角度思考。文档是为了解决他们的问题，而不是展示我们的实现。
• 示例驱动: 一个好的示例胜过千言万语。我们鼓励通过丰富的代码示例来阐述功能。
• 保持一致: 遵循既定的模板和风格规范，能让整个文档网站看起来更专业、更可靠。

不同内容类型的规范

Dora Pocket 是一个多元化的知识库，不同类型的“道具”需要不同的呈现方式才能发挥最大价值。

请根据你贡献的内容类型，参考对应的详细模板和规范：

• 🛠️ Kit 工具函数模板

  • 用于 @esdora/kit 库中的所有独立函数。
  • 特点: 聚焦于 API 签名、参数、返回值和边界情况。

• 🪝 Hooks 模板 (规划中)

  • 用于未来规划中的 Vue/React Hooks。
  • 特点: 将会更侧重于响应式状态、生命周期和副作用的阐述。

• 📖 最佳实践文章模板 (规划中)

  • 用于“最佳实践”板块中的深度文章。
  • 特点: 将采用“问题-原则-方案”的结构，更侧重于思想和模式的传递。