现在的位置: 首页 > 综合 > 正文

10.14–关于产品文档

2018年04月13日 ⁄ 综合 ⁄ 共 715字 ⁄ 字号 评论关闭

今天几乎都在忙文档的事情,发现自己写文档比做测试更能集中注意力点,可能对于写文档自己比较懂,甚至有很多自己的见解,而做测试的时候满头雾水,有的又很耗时,不免有些心里毛躁。

 

其实一个产品的帮助文档要设计好也是件不容易的问题,要站在客户的角度,易懂又能涵盖所有内容。人毕竟是人,要写的太详细了,估计写文档的人也会疯掉,肯定很容易出错,而且要统一出个风格也难,虽然已经做了一个文档编辑器,限定了所有的格式,但是还是很痛苦,一来是编辑器不好用,很容易出错,而来所写未必所得。虽然整个文档已经分成了学习教程和用户手册,让那些复杂的繁多的内容放到用户手册去讲,但是很多都放用户手册了,用户又反映教程太难,其实他们根本不愿意看用户手册,要让用户能够只看教程就学会使用我们的产品,一是虽然有用户手册,但第一次遇到的操作还是要详细解释,二是每一个页面的长度不一太长,太长了用户就没有耐心了,三是,不用太纠结于概念,给他个链接,他想了解,就到用户手册中去查阅,教程中只要能让他们按着步骤做不出错就行,四是,多添加链接,既要把用户想的超级白痴,每一个细节都不能放过,又要考虑到那些自以为是强人的人,在他突然发现自己原来什么都不懂的时候,给他指出一条出路,让其查阅。关于帮助文档到底还要怎么改,公司里几位小领导各有自己的意见,且坚持不肯放,诶...不过有矛盾,就有进展,在曲折中前进嘛,只要能把大家意见的精华融合起来,达到共识,就ok啦~~

 

写到这,不得不喊一句,我的脖子快断了,肩膀快断了,受不了了,前两天貌似有吃坏了东西,肚子难受的要死,真想回去躺着了。。。

 

明天还得忙文档,他们意见分歧归他们意见分歧,我自己按照我自己的来改,只要清晰明了就ok~~

抱歉!评论已关闭.