这是一个占位页面,将其替换为您自己的内容。
概述是您的用户了解您的项目的地方。根据文档集的大小,您可以拥有单独的概述页面(如本页面)或将概述内容放在文档登录页面中(如 Docsy 用户指南中)。
尝试在此页面中为您的用户回答以下问题:
它是什么?
介绍您的项目,包括它做什么或让您做什么、为什么要使用它以及它的主要目标(以及它如何实现它)。 这应该与您的自述文件描述类似,但如果您愿意,您可以适当写一些小细节。
为什么需要它?
帮助您的用户知道您的项目是否会对他们有所帮助,有用的信息可以包括:
它有什么好处?:您的项目解决什么类型的问题? 使用它有什么好处?
它有什么不好?:例如,指出直观上看起来适合您的项目但由于某种原因不适合的情况。 还要提及已知的限制、扩展问题或任何其他可能让用户知道该项目是否不适合他们的内容。
它尚未有什么用处?:突出显示即将推出的任何有用功能。
接下来我该去哪里?
为您的用户提供进一步了解产品的指引。 例如: