内容策划:如何编写产品手册? | 技术写作什么鬼

有朋友询问:如何编写产品手册?公司客户说不会用我们的网站,市场部让我们产品写产品手册,老大让我写,可是我没有写过这个东西,不知道产品手册到底要写什么,求指导。

产品手册,是一个非常典型的市场文档,各行各业,在面向客户介绍产品或服务时,都可能涉及。那么,今天就来简单分享一下,如何梳理思路,策划编写一本这样的文档。

大家好,我是睿齐,一个技术传播从业者,IT行业技术文档工程师。

了解常见文档类型

产品手册,是一个比较模糊的定义,每个人的理解都可能有所不同。因此,需要基于文档具体使用场景和信息需求,明确文档定义。

一般市场侧使用的产品文档,常见以下类型:

  • 产品手册:包含公司所有产品/服务的基本信息,用于面向客户,介绍公司提供的全部产品和服务。

  • 产品说明书/白皮书:包含单一产品信息,通常为产品配套输出,用于面向客户,提供产品详细信息,包括但不限于数据规格、功能特性、使用场景等,但一般不包括产品使用说明。

  • 产品用户手册:包含与产品信息,及使用说明、参考资料等。严格意义上讲,用户手册不属于市场文档,但对于操作简单的日常消费型产品,也可能会将产品说明和使用说明合并在一起。

明确文档需求和定义

那么,如何策划一个适用的产品文档呢?首先要搞清楚这样几个问题:

面向对象

市场侧产品文档的读者一般为客户,即决策是否购买产品的人;但也有可能需要兼顾用户,即使用产品的人。

需要特别注意的是,由于产品类型千差万别,客户与用户,可能是同一个人,也可能不是。客户与用户对于产品信息的需求,是存在微妙差异的,需要仔细甄别,有助于我们确定文档内容。

文档目标

开发文档从来不是“为写而写”,而是为了通过有效地信息传递,以期达到实际目标。

市场侧产品文档的基本目标是:

  • 全面介绍公司的产品和服务

  • 详细介绍产品信息

  • 详细介绍产品信息和使用说明

进一步的目标是:

  • 突出产品竞争力

  • 展示公司实力、理念,以期赢取信任

终极目标通常是转化为实际销售。

所以,如何实现文档目标?带着这样的问题去思考,同样可以帮助我们确定文档内容。

传播方式

市场侧的产品文档,不仅需要考虑内容,还需要考虑传播方式,来确定最终文档形式。

常见的文档形式可以是:

  • 电子版:通过官网下载、售前人员交付等形式分发;

  • 印刷版:通过销售人员投递、展会等形式分发;

  • 宣讲PPT:通过会议、培训等线上线下讲解等形式分发。

  • 媒体:通过内容平台分发。

  • 多媒体:通过音视频、小程序等形式分发。

不同的传播方式,对文档的内容组织、字数显示、版面设计、开发方式等,会产生不同程度的影响,需要综合考虑。

产品白皮书内容示例

本人主要服务于IT行业,在此仅以产品白皮书为例,简单说明常见内容:

  • 产品描述:包括但不限于产品定义,典型使用场景,主要功能特性,产品亮点。

  • 产品架构:说明产品与周边生态环境的关系,便于用户理解产品定位。

  • 功能特性:说明产品的主要功能,建议包含二级功能。

  • 产品优势:说明产品的竞争优势,便于用户理解产品亮点。

  • 使用限制:说明产品无法使用的场景,便于用户取舍。

  • 应用场景:说明产品典型的用户场景,便于用户结合自身使用需求,确定是否可以使用产品。

内容基本要求

适用不同场景的文档,对于内容需求有所不同,但是对内容的基本要求包括:

  • 符合产品实际:产品信息符合产品实际,避免虚假宣传。

  • 配合市场策略:突出产品亮点和竞争力。

  • 满足信息需求:凡是文档目标读者需求的信息,需要包含。


最后,文档开发不一定要从0起步,竞品文档调研是非常不错的手段,可以帮助我们快速上手。通过博采众长,学习借鉴;再结合实际使用需求,选取适用部分;重新组织、优化后,就可以圆满完成文档开发任务啦。

以上,是我个人对市场侧产品文档的一些浅见,希望对刚好有需要的朋友有所启发。如果有没有说到,或者说得不够透彻的地方,也欢迎进一步讨论。

其他推荐:

实施:GitHub + MarkDown 文档系统的工作环境部署及工作流程说明 | 技术传播

603622bab58966053876b9ac1bd2ebce.png

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

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

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

在座都别吵了,你们还有我

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

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

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

转战新媒体 | 技术传播

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

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

企业级信息管理系统初创方案构思 | 技术传播

 fbe131a9a0b556d89343ff580ddcce81.png

睿齐

技术传播从业者

品牌内容策划

自由摄影师

自由撰稿人

汪力迪

公众号:techcomm / htstory

微信号:bgrichi

邮箱:hash_0813@163.com

4bdb24f4a6194720b1ec1018fc19156e.png

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值