【写作模板2】工具、平台、组件、框架的介绍

115 阅读2分钟

有时候我们会遇到一些好的工具,或者组件,框架,此时想给大家做一个入门介绍,这种情况下,可以参考下面这个模板,一样是填空即可

背景

主要是概述,让用户对所述内容有个大致认知。可以写该产品是什么,主要能力有哪些,主要服务了哪些业务线或有多少人应用。

过去时间,该产品经过了怎样的迭代过程,目前的发展阶段是什么,你负责研发了哪部分(或者如何学习了解了该平台)。本文着重介绍该产品的XX。

应用场景

主要介绍用户可以在哪类场景下使用该产品,也可以介绍历史的哪些场景中使用过该产品(如有历史场景的使用截图建议添加)。

核心概念

如果介绍的产品中包含一些专有名词,或者下文会提到的一些高频概念,可以在此部分给出解释,如果没有也可以不写。

整体架构

这里展示产品的总体架构,建议直接使用飞书文档中的流程图工具绘制。展示图片的同时通过文字对产品的层级、架构进行介绍,每部分分别是什么,是如何配合的。然后分小标题介绍每个层级、架构是如何运作、设计的。

应用实践

举一两个典型的例子,介绍该产品的具体应用案例,并给出一些具体的数据。最好也能给出使用该产品前后的对比数据。

参考阅读

给出该产品的接入文档、使用指南文档链接。

给出和本文所述产品相关的更多文档