信息是一条河流,贯穿整个研发生命周期 | 技术传播

在我的头脑中,总会浮现出这样一幅景象:一条河流,发源于高原,迂回曲折、淙淙流淌,直至汇入大海——如此像极了信息贯穿整个产品周期。

在一家科技公司中,常以产品研发部门位于C位,同时辅以周边各部门的通力协作,共同实现产品价值。

上游与下游

站在产品研发的立场环视周边,按照信息流入、流出的顺序,可区分为上游和下游。

上游,面向客户,是需求来源的地方,常由市场、销售等售前部门对接;下游,面向用户,是产品将要去向的地方,常由技术支持、运维等售后部门对接。

市场文档与用户文档

为使上下游部门,及至客户与用户,获取到各自所需的产品技术信息,产品研发部门作为信息的来源,需发布一系列产品技术文档,并确保信息保持一致。其中,面向上游发布的文档,即为市场文档;面向下游发布的文档,即为用户文档。

市场文档和用户文档都是体现产品技术信息的文档,但是由于面向对象、使用场景、应用目标各有不同,组织思路亦不相同。

市场文档往往面向客户进行产品介绍,不仅要符合产品实际,还要结合不同的销售策略,突出产品特性、技术亮点、竞争优势,目的是说服客户购买产品;用户文档往往面向已经购买产品的用户进行产品使用方法说明,以期帮助用户独立使用产品。

常见技术文档

常见市场文档包括:

    - 产品白皮书:用于向客户介绍产品基本信息、功能特性、技术亮点、竞争优势等。
    - 产品手册:用于向客户展示已有产品列表及其信息。
    - 产品宣传单页:用于向客户展示产品单品及其信息。
    - 技术要求应答:用于汇总常见客户问题的应答。
    - 市场宣讲文档:用于客户宣讲。

常见用户文档包括:

    - 安装部署手册:用于指导用户如何安装、部署系统。包括:硬件安装、软件安装、网络规划部署等。
    - 升级指导书:用于指导用户如何升级已有系统至最新版本。
    - 用户手册:用于指导用户如何使用系统。
    - 运维手册:用于指导用户如何维护系统正常运行,包括:日常巡检、告警处理、故障排查等。
    - 开发手册/接口说明:用于指导用户如何基于系统进行二次开发。
    - 版本变更说明:用于告知用户当前版本基于上次发布的主要变更。
    - 技术培训文档用于用户培训。

需要特别说明的是:

    - 如果没有很好地区分市场文档和用户文档的行文立场,可能造成信息混淆,致使可用性下降。
    - 上述常见文档列表并非必选。需结合不同产品的具体信息使用需求,有选择、有侧重地进行文档系统的整体规划。



其他推荐:

技术传播是一片蓝海| 技术传播

访谈:TC无处不在,只是我们没有发觉 | 技术传播

这次他们说好要“讲真的” | 传播

在座都别吵了,你们还有我| 技术传播

一本培养强迫症患者的说明书 | 技术传播

就像用心做好日本料理 | 技术传播

顽固的老头子与无聊的说明书 | 技术传播

转战新媒体 | 技术传播

评测:王者荣耀的用户帮助系统 | 技术传播

让爸爸妈妈也能享受到科技发展带来的便利 | 技术传播

你可能感兴趣的:(信息是一条河流,贯穿整个研发生命周期 | 技术传播)