写出优秀的产品手册文档的技巧

Baklib
+ 关注
2022-09-06 14:38
217次阅读
目前,大部分软件产品都是通过互联网为用户提供服务,而在线文档则是最有效的服务方式渠道。
好的文档是优秀产品的标配,它不仅可以帮助你带来更多的用户,还可以帮助你的客户得到更多的关注。作为一个网络编程人员,如果你不懂得如何撰写一篇优秀的技术文件,那么你就会感到不好意思,更不要说制造出一个完美的产品了。
写出优秀的产品手册文档的技巧
 
“不知道从哪里入手,没有合适的视角,没有合适的写作方法”,这些都是我们经常碰到的问题,为什么会这样?往往会发现自己的思维不够灵活,思维也就不能展开。
因此,在下笔前,我们要搞明白,这份文件是由谁撰写的,以及它能帮助读者解决哪些问题。写作是一种可以输出影响的能力,其终极目标是改变读者的信息、行为或信仰,不然的话,就会变成一堆废纸。当我们清楚地了解了目标读者和意义以后,我们的思想就会开放。
其实,大部分的潜在客户都是初来乍到,不太懂我们的产品,也不清楚他们的产品能给他们带来哪些问题,给他们带来哪些利益。
非功能性特征取决于功能性特征。一个对使用者来说没有任何价值的产品,即便其非功能性的特点再好,也不会让使用者感兴趣。
文档开始时,一定要让使用者了解到,该产品或计划与其工作紧密相连,从而使其达到最佳效果。其次,要让用户了解产品和计划是什么,以及怎样使用。这与开发软件的流程很相似。从用户的需要入手,对用户的痛点进行分析,并对其进行深入的研究,为其设计出针对其难点的产品,并最终完成其开发与实施。
在我们把文章的目标读者和能够帮助读者解决的问题弄清楚之后,写作就会有一个方向和价值,从而激发我们的身体和精神,使我们的文学思想奔腾起来,这就是使用者的思想。从这个角度出发,我们可以思考文件中应包括哪些内容,怎样编排和编排目录章节,使之与使用者的学习规律相一致。
文档是我们向外输出的产物,要学会换位思考,从使用者的观点来思考他们所需要的是哪种产品或计划;在技术选择时,使用者会先确定其价值,然后再去了解其特性和用途。
写出优秀的产品手册文档的技巧
 

全景视图

全景视图,使用者能以上帝的角度来了解整个产品或计划,而不会有很多细节。就好像在热带雨林中穿行,一头进入树林,很容易迷失,最好是在高处或树梢上,仔细观察整片树林,了解河流的走向,了解地形,了解了这一点,我们才能更有把握离开这片树林。
全景视图图就像一个框架,它承载着信息。我们首先要协助使用者构建此架构,并将细节提供给使用者。在这个时候,使用者可以把它放在不同的地方,这样他就不容易迷失了。所以,本文的第一部分是对产品的总体介绍,包括背景介绍、功能定位和优缺点的对比。

建立演示环境

在对这个产品有了一个完整的理解之后,这个应用架构师就会建立一个更直观的关于这个产品的展示环境。在此阶段,他不必对所有的细节都有特别的全面和深刻的理解,只要知道怎样以最快的速度来进行配置就行了。

开发指导方针,介绍产品特征

通过上面的两个部分,我们让使用者了解这个产品能帮他们解决哪些问题,并且了解他们的工作原理。下一步,用户开发,测试工程师,以及其它的角色都会参与进来。为了引导特定的代码实施,他们必须对产品的性能和用法有更深刻的理解。
所以,文章的的第3部分是一个开发指南,它将引入到产品的功能。不同角色的使用者对文件的要求也不一样,因此,文档章节目录的设计要遵循以上的次序。

监视微型业务

第四部分,除了了解该产品的使用方法之外,还要关注在日常使用中的操作与保养,是否有相应的辅助工具或管理平台来监督微型服务的运行,并对微型服务进行控制与管理。

常见问题的整理

第五部分介绍了在使用中出现的问题,尤其是经常出现的问题。
1.产品介绍2.快速开始3.发展指导4.使用指导5.常用问题6.典型案例7.历史版本8.下载说明

易于操作

工具在线使用时不需要下载地址(零试错费用)。操作流程简单,无需基本的程式码,会基本的电脑错误就可以了。
支持通用 Word文件的全系列编辑,可任意插入表格,代码块,图片,本地音视频,在线多媒体,简化文档的建立。

结构文档

提供了多级栏目和标签云的功能,实现了对知识内容的层次梳理,通过文档大纲,可以自动产生文件的重点,使得多个文件结构化,就像一本书,使得需求文件的结构更加易于理解。

可靠的资料

提供资料人工备份,使用者可在当地储存资料。开放 api界面,通过调用界面来快速输出和导入数据。在编写内容时,具有自动缓存历史资料的能力,可防止因误操作而造成的资料遗失。

小组合作

该工具支持多人在线合作的文件编辑,在需要多个用户合作的情况下,可以使用内部的团队合作功能来实现。协同成员的权限控制,保证了系统的数据安全性,提高了工作的效率。

实用的外挂

这个工具提供了许多有用的插件,比如
站点权限设置:可以自由地进行控制,能够访问帮助站点的使用者的权限。
独立域名:支持独立域名绑定,域名 ssl密码。
全局搜索:采用相似于百度的搜索机制。
写出优秀的产品手册文档的技巧
 
最后,我还给大家推荐了一个实用的工具:
Baklib是一款在线的文件编辑和分享工具,在操作习惯上支持 Word文件通用全系列的编辑操作,任意插入表格,代码块,图片,本地音视频,在线多媒体,让知识创作变得简单。

[免责声明]

原文标题: 写出优秀的产品手册文档的技巧

本文由作者原创发布于36氪企服点评;未经许可,禁止转载。

资深作者Baklib
Baklib
0
消息通知
咨询入驻
商务合作