Loading [MathJax]/jax/output/CommonHTML/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >如何写一篇产品文档

如何写一篇产品文档

原创
作者头像
研究僧
修改于 2020-06-11 03:44:37
修改于 2020-06-11 03:44:37
1.9K0
举报

开篇

笔者有着多年的toC开发、运维开发和运维工作经验,也曾开发很多内部运营系统,更多是从功能角度出发满足业务运维的需求很少提供完整规范的产品文档,关于开发的运营系统使用方法更多是通过口口相传,听起来不是很正规但确实是这样走过来的。

笔者也反观公司内部的运营系统也会出现笔者遇到的情况,或者是提供了基本的文档但随着时间的推移文档年久失修,甚至出现问题联系文档里的负责人已经离职的囧境。

两年前笔者开始从事toB业务明显感觉到与toC业务的不同,相应的产品要有配套的文档和说明书且产品文档要优先于版本迭代,最起码也需要同步于产品迭代功能发出。

ToB面向企业级别用户文档是一个必不可缺的产物,但用心整理的产品文档并提供用户也会遇到一些问题,譬如产品运营的过程中我们经常与用户交集的Helper(在线服务客服)会比较困扰因为用户没有看文档的习惯更喜欢直接来问Helper,所以有时也在思考是否要投入更多的经历来完善文档? 为什么用户不看文档?我们的产品是否出现了什么问题?很多的问号盘旋在脑海中。但思考过后最终的答案还是非常肯定的文档是产品非常重要的一个环节,用户可以不看但我们一定要提供并且精心的维护它。下面就通过一个真实的案例ULS产品文档开发过程,来介绍如何写一篇产品文档,以下是ULS产品文档目录结构。


ULS产品背景介绍

ULS(Unified Log System) 统一日志服务,是内部的一套开发上报日志、存储和最终消费一站式平台。 此产品是在2018年底开始由我们部门负责,从ULS代码注释中可以看到它大概7年前(2012)开发的是一个有历史的内部日志系统同时有一批忠实的用户。

竞品文档结构调研

ULS产品是一款有历史的内部系统经过了多年的发展,文档散落在各处另外很多文档也年久失修有很多的错误,我们优先整理了旧文档列表并验证旧文档没有问题后,统一放到现有系统显眼位置让用户第一时间可以看到。接着我们对日志服务竞品的文档结构做了一些调研,这些产品包括腾讯云、A云和QN云,竞品目录结构对比可以访问( https://docs.qq.com/sheet/DTkZRSGZORkZvdHZq?opendocxfrom=admin&preview_token=&coord=K15A0A0&tab=BB08J2 )。

经过竞品调研并结合我们当前的实际情况,最终我们的文档结构一级目录为,版本更新历史、快速上手、5分钟视频介绍、产品介绍和FAQ问题整理等。 有了文档结构后在此基础上我们将老的文档中一些信息进行整理并灌入新文档系统中,这里强调一下我们使用的是GitBook来管理我们文档,有很多内部系统依然使用Word文档来管理,笔者觉得更加推荐GitBook它有版本管理功能,在并行开发文档过程中避免出现错误与覆盖的情况,同时可以对比不同版本间的差异方便我们优化文档,最主要他呈现给所有人是一个WEB网站,信息更新也更加的实时。

寻找用户群体

个人觉得做产品最重要一个环节是用户群体,只有了解用户群体我们在产品迭代过程中的取舍才会有依据。这里举个比较形象的列子也是笔者之前一直在思考的问题,为什么Windows系统有回收站而Linux系统没有回收站?后者的答案笔者在《Unix编程艺术》找到,这句话来自书的原文——Linux世袭了Unix的设计理念与传统,而Unix本身并没有这样的设计并延续到了Linux。Unix面向更加专业的用户 ,Unix的开发者喜欢清晰、简单的操作,用户告诉做什么就做什么,即便用户使用的命令等价于“向我开枪”的命令。而这样做Unix的开发本能辩解的就是:保护用户避免自我损害,应该是GUI或应用程序级别的事,而非操作系统。 所以可以很清楚的看Linux的用户群体更加的专业,Windows系统正好反过来,如果用相机比喻的话Windows更像傻瓜相机,Linux是一个专业的数码相机彼此之间有自己针对的用户群体。

我们对日志竞品产品调研也再次验证了这个结果,这里包括QN云智能日志平台 、A云日志服务和日志易等业界日志产品做了深入的调研并与ULS进行对比发现不同的产品在功能上是有取舍和针对性的(竞品调研报告:https://docs.qq.com/sheet/DTkdtREdPU2dES2ZG?preview_token=&coord=B4A0A0&tab=BB08J2),从产品功能上来反推用户画像:

A云:用户群体需要具备更强的开发能力,而其系统更多像一个脚手架与A云产品相互打通,用户具备开发能力通过脚手架可以实现常用功能外的一些定制化开发需求。

QN云:用户人群需要有计算机的背景但并非一定需要较强开发能力,该产品提供了丰富的功能和强大的用户WEB界面,基本可以满足常见用户的80%需求场景。

某易:功能和文档十分不完整,从日志易的立足行业(金融、能源、运营商)看到,日志易有为不同行业提供不同的解决方案。用户画像:需要个性化定制日志服务的企业。

ULS(内部系统):目前内部运营了7年多有一定的铁杆粉丝量,所以ULS用户画像就是内部的开发,这些开发主要集中在CSIG、PCG和少量的IEG等,这也能看到我们系统用户的属性。

详细调研报告可以参考:( https://docs.qq.com/sheet/DTlNZZE1FQ3hxc3NW?opendocxfrom=admin&preview_token=&coord=A4A0A0&tab=BB08J2 )

有了用户群体后我们在写文档时就有了依据,譬如笔者在文档中写过ELK有同学会挑战需要介绍ELK是什么, 但我们的产品用户群体是开发,他们会具备一定的知识基础,依据这背景笔者是不会在文档中写过多的ELK介绍的。

文档正确性校对

在刚开始的时候我们从能收集到的历史文档中搬了很多东西到新创建的文档系统。这些文档多由老的日志系统开发撰写,在实际操作过程中我们发现安装文档执行并非100%执行成功或者说文档只写了在安装过程中最好的情况下是什么样的,我们通过多位测试同学不断的对文档验证与校对,并对文档中的内容进行重新排序与分类最终达到我们预期的效果。 这里有一个值得分享的案例,譬如我在安装日志服务的Agent,其实我们直接通过运营系统下发就可以了但我们运行的服务器环境在文档上并没有明确操作系统发行版本是什么,kernel版本号,是否经过初始化系统等。 笔者通过验证文档安装的服务器每次都会执行成功,而测试同学每次测试都失败,其实主要原因就是我们使用的服务器初始化系统不一样导致系统上缺少依赖包,测试同学在安装Agent时就会报错,这些细节都是通过一步步测试后发现并整理到文档中的。 而我们的文档在迭代过程中一定需要经过测试同学进行严格的流程测试才能保证它的正确性,最终提供给用户也是靠谱的手册。

一定要有的CHANGELOG

在产品开发过程中一定要通过版本来迭代需求。 以ULS为例,我们有自己的用户群体,在用户群里中又建立了产品相关的社区,通过社区的反馈不断收集用户的意见,根据用户的意见在每次版本迭代中进行优先优化,每一个版本我们都能看清楚他的优化点与用户关心的问题,每次迭代一个版本并对比版本之间的变化会发现你的产品会更上一个台阶,我想这也是做好一个产品的方法之一。

不能没有的FAQ

开篇我们说过其实最头痛的是提供了用户文档用户不去看,我想这也是很多人的用户习惯,如果文档与Helper都在的情况下,很多人会优先询问Helper。其实在接Uls产品的时候我们就建立了这里处理问题的流程见以下截图,我们有1线,2线(uls_helper)和研发,收集用户每一个信息并统计分析整理有共性的问题录入文档的FAQ中。有了流程的保障会发现FAQ整理的问题慢慢的增多,随着时间的推移用户可以社区内发出问题,并由其他用户以文档的形势进行内部闭环,释放产品的人力投入,形成良性的需求与供给,所以在文档中的FAQ是非常重要的一个环节。

文档中视频演示的重要性

对比日志竞品文档提供视频演示并不多,但是在运营日志产品的过程中发现了用户的习惯,这里再一次强调就是很多用户不习惯看文档,所以我们也尝试通过视频演示方式是否更好。在准备视频演示的过程中也发视频演示和产品文档是相辅相成的事,从最开始录制视频大约需要7分钟逐步优化文档结构和安装程序到最终将整个时间控制在3分钟左右,这也体现了准备视频演示对文档建设的推动作用。

最后,笔者觉得一个好的产品要尽量让用户少看文档,印象中看过一个文章说Iphone的开机按钮连不到一岁的小朋友知道去按并开机。希望每个人都是一个好的产品经理并作出更优秀的产品。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
用ChatGPT帮你写产品文档
本文作者:jasonyewang,腾讯IEG产品经理 一、为什么是产品助理 我想让GPT成为我的产品助理,那为什么不是GPT直接成为产品经理呢?因为通过我大概近几个月的使用,我认为GPT暂时还不会直接取代产品经理。 产品经理是需要依据用户需求、业务环境和技术可行性,整体去设计产品方案。现阶段的GPT对上下文记忆能力可以随着输入文本长度的增加而降低,所以如果需求场景比较复杂,GPT是无法根据你的一句话需求来产出完整的产品方案,最多也只能做到完成一套非常通用例的产品方案。 那么作为产品助理,GPT能帮忙处理什么
腾讯大讲堂
2023/05/19
1.3K0
用ChatGPT帮你写产品文档
【安全】产品文档捉虫活动
为了提升广大用户的文档的使用体验,现推出【安全】产品文档定向捉虫活动。邀请大家对指定产品文档进行体验,反馈文档问题就有机会获得腾讯云电子代金券、京东储值卡和神秘好礼!发现和反馈的文档问题价值越高,奖品越丰厚。
腾讯云文档
2023/12/05
8550
【安全】产品文档捉虫活动
为什么ToB产品需要这么多文档?
大家都知道编写产品文档是PM的工作内容之一,对于ToC和ToB的产品来说,编写的产品文档也会存在一些差异性。
奔跑的小鹿
2021/09/28
7660
为什么ToB产品需要这么多文档?
B端平台型产品,如何高效进行用户调研
本文作者:ewayzhang,腾讯IEG产品策划 摘要 近期由于工作需要,短时间内进行了大量的用户访谈调研工作,基于之前在B端商业型产品中做用户调研的经验,结合本次遇到的困难和问题,对调研相关的内容做整理分享给大家,希望有所帮助。 所谓B端平台型产品,通俗意义上是指在某个垂直领域下,把诸多业务线上化的产品或工具,通过平台化的搭建,实现诸多业务价值赋能,如效率提升、延伸价值链、打通业务之间壁垒等等。 现在还是祭出万能的5W1H分析法,来对本文内容做整体的进行思路整理。 What:什么是用户调研 用户调研侧重
腾讯大讲堂
2021/12/29
2.1K0
网络产品文档定向捉虫活动
为了提升广大用户的文档的使用体验,现推出网络产品文档定向捉虫活动。邀请大家对指定产品文档进行体验,反馈文档问题就有机会获得腾讯云电子代金券、京东储值卡和神秘好礼!发现和反馈的文档问题价值越高,奖品越丰厚。
腾讯云文档
2023/04/04
7.1K0
网络产品文档定向捉虫活动
【办公协同 & 微信生态 & 物联网】产品文档捉虫活动
为了提升广大用户的文档的使用体验,现推出【办公协同 & 微信生态 & 物联网】产品文档定向捉虫活动。邀请大家对指定产品文档进行体验,反馈文档问题就有机会获得腾讯云电子代金券、京东储值卡和神秘好礼!发现和反馈的文档问题价值越高,奖品越丰厚。
腾讯云文档
2024/04/09
5350
【办公协同 & 微信生态 & 物联网】产品文档捉虫活动
竞品分析怎么做?我只告诉你一个人!
前面写的文章中提到过,我们大部分产品的小伙伴接触从零到一的产品概率并不高,这时候我们更多做的是功能点的竞品分析,功能点的竞品分析一般我们会在三种情况下去做,它们分别是:
靠谱先生
2018/09/10
1.7K0
竞品分析怎么做?我只告诉你一个人!
运维汪转向产品狗的幸(dan)福(teng)之路
写这篇文章的初衷是想总结下自己从业务运维岗转到产品经理岗后,大半年来如何从“零”开始的一路摸爬打过来的经历。
腾讯大讲堂
2018/04/27
1K3
运维汪转向产品狗的幸(dan)福(teng)之路
什么是To B产品,以及如何构建To B产品
导语|作为一位已经做了10年产品的老司机,C端、B端(包含To G)产品都做过不少。在拥抱产业互联网的今天,我想为大家分享一下近几年做To B产品的一点体会,希望可以对大家的工作带来帮助。 本文作者:leochaowang,腾讯TEG产品运营 首先是概述,讲述什么是B端产品,分类是如何的,接下来是“策划相关”,主要涉及产品调研和行业研究、架构设计、功能模块设计和一些基本功能设计的通用化方案;最后会涉及长期运营和迭代涉及的体会。 一、做B端产品的总体感受  B端产品也叫“2B(Bussiness)”产品,使用
腾讯大讲堂
2022/11/18
1.3K0
什么是To B产品,以及如何构建To B产品
2、产品经理深入浅出系列——产品经理的职责
==================  1、市场调研分析  ================= 1.1 了解市场需求 -与潜在用户交流尝试能否获取需求 -明确目标用户群体与特征(年历、收入、性别、心理特征) -直接与面对客户的一线同事交流,如销售、技术等 -获取,分析,评估用户的需求   -> 需求收集   -> 需求的分析评估: 是否迫切、是否强烈、是否高频 1.2 分析竞争状况 -市场报告 -行业文章 -使用竞争对手的产品 1.3 自身资源与满足用户需求的匹配程度 -技术资源   -> 是否存在
陈树义
2018/04/13
9250
产品即文档?PM只是差一款全新的PRD利器
产品行业的从业者千千万,但为什么有些人就能以野蛮生长的方式快速上升,有些人看似忙碌到不可开交却始终原地踏步?我想,在过完了又一天的朝八晚十后,很多产品经理也会向日渐憔悴的自己发问:我和产品大神的差距究竟在哪里?
奔跑的小鹿
2020/01/10
7060
产品即文档?PM只是差一款全新的PRD利器
产品经理是如何做好产品规划的
产品规划作为产品经理的核心工作职责之一,是每一个产品经理职位JD中必有的关键词。作为一门较为高阶的产品技能,产品规划是产品经理职业长期发展中必不可能绕过的重要一环。不管你是产品小白还是产品大拿,都需要对其建立足够清晰的认识,并在工作中落实。
奔跑的小鹿
2024/01/05
5430
产品经理是如何做好产品规划的
这4种分析方法,大牛产品经理都在用
导读:设计产品有两种常见方式:一种是坐在办公室里拍脑袋设计;一种是先深入一线进行用户调研,然后基于调研结果来设计。
IT阅读排行榜
2022/04/14
5390
这4种分析方法,大牛产品经理都在用
B 端软件:怎样进行竞品分析?
不管是从零开始做一款软件,还是在现有的软件中进行功能迭代,都少不了去找一些类似的软件和功能进行研究,这个就叫竞品分析。
oec2003
2023/09/01
5110
B  端软件:怎样进行竞品分析?
产品经理必看的高效产品文档撰写指南
对于企业来说,如何推广自己的产品是一个非常重要的话题,而其中必要的就是创建企业产品宣传册,这对于产品宣传非常重要,尤其是一些大公司,非常重视这种产品展示方式。因为它可以更完整地展现产品,撰写一份合理有效的产品文档,让客户了解产品,客户甚至也可以了解企业的工作风格。
小炮
2022/03/24
4570
项目管理——产品文档规划
一、本地文档如何管理 项目通过文件夹管理 经受过的项目比较多,我按照“开始月份~结束月份+项目名称”的方式来命名,方便后续回顾。 按照职能设子目录 比如我们是PM,那主要资料应该是需求文档,其次经常被
Java帮帮
2018/03/19
1.9K0
项目管理——产品文档规划
【你找茬儿,我发奖】腾讯云产品文档“捉虫”活动
使用腾讯云文档过程中,如遇文档问题,欢迎在 腾讯云文档中心 选择目标产品文档 进行反馈,我们将有专人跟进解决您的反馈或建议。腾讯云邀您参与文档共建有机会获得腾讯云电子代金券和精美奖品。 如果文档曾帮您解决过困惑,也欢迎为我们点个赞,我们会努力做得更好,感谢您的支持。
腾讯云文档
2020/04/08
13.7K38
【你找茬儿,我发奖】腾讯云产品文档“捉虫”活动
如何着手设计SaaS产品的新用户旅程?
我是腾讯云安灯(ITSM SaaS)的产品策划,主要负责公司产品的基础服务部分,包含账号权限、租户平台、登录流程设计等。这些模块相对业务模块来说较简单,在MVP版本中属于重要却非核心功能。
腾讯云安灯_jiaxin
2023/02/14
9750
技术转产品经理:这是我对项目的一些思考
前言:产品是对综合能力要求很高的一个职位,只有不断的思考、不断的更新知识体系,对这个行业充满着未知的探索,才能保持一颗初心,打磨出一款出色的产品。 背景:毕业后比较幸运地进入一家较大互联网公司做了两年研发,在两年之内也接触了不少的运营和产品;做过大大小小的项目,由于想尝试自身更多的可能性,或者说得更直接一点,想成为一个决策者。 由个人追求的转变,于是决定转行产品经理。 有了这个想法之后,在工作时间之外开始学习产品的知识,从最基础的产品工具,到产品书籍,最后和几个朋友做了一些小的产品需求。 离职后,开始准
企鹅号小编
2018/01/10
2.3K0
技术转产品经理:这是我对项目的一些思考
大数据产品竞品清单汇总(附链接)
近期有人在公众号后台私信我,问数据产品经理有哪些可以找目标竞品的方法。C端产品,度娘或者应用市场一搜,可能竞品就出现了(广告竞价或SEO策略的同质化),。数据产品一般是面向企业内部,只有提供商业化服务的企业才可以找到公开的资料,所以寻找竞品时,要基于对行业的一定了解,以及外部辅助信息的输入。做数据产品七八年了,埋点采集、数据可视化统计、精准营销平台、BI工具、数据资产与治理、大数据开发工具,数据全流程各个领域都有所涉及,把过往收集整理的数据产品信息汇总、分类整理分享给大家。按照从上层应用到底层数据开发的顺序,整理如下:
数据干饭人
2022/07/01
2.5K0
大数据产品竞品清单汇总(附链接)
推荐阅读
相关推荐
用ChatGPT帮你写产品文档
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档