文档规范之目录结构

概述

文档目录是整个用户文档的关键索引，文档目录的好坏在没有搜索功能的帮助下很大程度的确定了用户能否在有限的时间内查询到所需的内容。

三大主类目录

文档目录通常来说，可分为三大主类，产品描述、使用指南、常见问题。

• 产品描述：即对产品的定义进行说明，如产品介绍、产品功能、产品功能等进行描述，主要帮助用户对产品的了解，用户可从自身角度出发考虑该产品是否满足自身需求。

• 使用指南：主要包括各产品功能如何进行使用，如何操作进行指导。

• 常见问题：主要包含用户经常性咨询的问题，以问答的方式展显给用户。

三大类可自由拆分和组合，如产品介绍部分内容可不包含在同一份用户文档中，是否包含主要取决于产品形式。

常见问题也可包含在产品介绍或使用指南中，如针对一篇文章的常见问题、一个功能块的常见问题。

四大辅类目录

文档目录还可包含四大辅类，辅类的作用主要有解决问题的易用性、产品形式所必须等。分别为最佳实践、产品规则、购买指南、法律文件。

最佳实践只要针对产品的使用场景进行 step by step（一步一步） 的进行指导，主要针对组合产品的多个功能进行使用，达到某个需求的目的。组合也可非本产品的其他产品功能。
产品规则即对产品的自定义规则、限制性规则进行说明，主要帮助用户快速了解使用该产品时存在的使用限制。
购买指南主要说明产品的计费逻辑、购买操作等。计费逻辑通常来分为2类，预付费计费逻辑、后付费计费逻辑。
预付费计费逻辑即对该用户在使用该产品前，预先支付费用一定的价格，购买一段时间或一次性的产品使用权。
后付费为也可称为按量付费，指用户先行使用一段时间或一定使用量后，通过制定的期限统一进行结算的付费方式。
购买操作即对如何进行购买、续费、退订、关闭开启自动续费等操作进行指导。
法律文件即需要给用户查看和说明的法律相关文件，如服务协议，隐私协议等具备法律效益的文件。