总览

概览是您的用户了解您的项目的地方。根据您的文档集的大小，您可以有一个单独的概览页面（例如这个）或将您的概览内容放在文档登录页面中（例如在 Docsy 用户指南中）。

尝试在此页面中为您的用户回答这些问题：

它是什么？

介绍你的项目，包括它做什么或让你做什么，你为什么要使用它，它的主要目标（以及它是如何实现的）。这应该与您的 README 描述类似，但如果您愿意，可以在此处进行更详细的说明。

我为什么要它？

帮助您的用户了解您的项目是否会帮助他们。有用的信息可以包括：

• 到底有什么好处呢？：您的项目解决了哪些类型的问题？使用它有什么好处？
• 有什么不好的？：例如，指出可能直观地适合您的项目但由于某种原因不适合的情况。还要提及已知的限制、扩展问题或任何其他可能让您的用户知道项目是否不适合他们的事情。
• 它*还有*什么不好的地方？：突出显示即将推出的任何有用功能。

我接下来应该去哪里？

为您的用户提供概览中的后续步骤。例如：

• 快速开始: 用项目开始 $project
• 示例: 查看示例代码!