2、帮助文档 #

#lfeng/wellplay/能力综述/帮助系统

帮助文档是一篇独立的文章，一个应用可以创建多篇文档，仅当文档被绑定到帮助目录时，文档才在客户端可见，文档自身的内容会在用户打开时展示，但文档自身的标题仅作为在控制台检索文档时的备注。

1、文档组成 #

为了统一显示效果，帮助文档由以下元素组成：

• 文档标题：文档自身的标题，不会显示在客户端，仅作为控制台检索、组织管理使用。
• 文档正文：由多个文档元素组成，文档元素决定了文档的布局和排版。

1.1、文档元素 #

目前，文档元素包括标题、正文、图片三种，用户可以通过控制台的编辑器进行组织编辑。

展示时会按照预设的格式进行展示：

1.2、文档管理 #

为了灵活的组织管理帮助文档，开发者可以先在后台创建多篇帮助文档，作为帮助系统的原始素材，再在帮助目录中对文档进行组织管理，仅当文档被关联到某个帮助目录时，客户端可以访问并查看到该文档。