marshel的专栏

首页博文目录订阅
正 文

写好产品手册也是为客户创造价值

(2009/3/27 22:09)
标签:上海艾为 产品手册

写好产品手册也是为客户创造价值
---我对文档编写工作的一点体会  

   张忠
   2009-1-21

    “客户的需求是艾为存在的唯一理由”,如何最快地为客户提供低成本、符合需求的的、好的产品无疑是“高素质的艾为人”,尤其是研发人员工作的重中之重。但仅仅是产品好还不够,产品手册的质量也至关重要。产品手册质量的好坏,直接影响客户对芯片的理解和使用,影响到我们的技术支持的投入力度,关系到产品最终是否成功,绝对不能掉以轻心。而这往往是“技术流”的设计人员最容易忽视,也不易做好的事情。针对这个问题,我想与大家交流一下自己这方面的心得、体会。

    产品手册是产品的一部分,它和产品本身不是“本”和“末”的关系,二者都非常重要,我们必须像产品开发一样重视产品资料编写。任何产品的成功都不单纯是技术的成功,设计完成只是万里长征的第一步,卖得好才能够为客户创造价值。当客户第一次接触艾为的产品时,对产品的了解极其有限,所有对产品的认识都只能从阅读艾为的产品手册开始。产品手册决定了客户对艾为产品的第一印象的好坏。
    现在的芯片往往功能很多,技术指标、功能描述、寄存器说明等等一大堆,动不动就是一大厚本,让人看了后面就忘了前面。我们的技术支持,半数以上的都是解释关于产品性能和使用方面的问题。而这些都清楚地写在说明书中,但用户并没读到或没读懂。与其抽出技术人员天天救火,不如一开始就在产品资料上下足功夫,不仅减少了开发人员的负担,提高技术人员的工作效率,而且用户也高兴,何乐而不为呢?

    好的产品手册,首先必须保证内容的正确性。但这个看似极易的事情往往不易真正做到位。“高素质”的人,最容易犯“低级错误”。“最安全的地方,往往是最危险的地方”,这个比喻非常适用于我们的文档编写。越是简单的东西,越容易出错。文档作者和审核人员在编写、审核产品手册时,对复杂的功能描述、技术指标等“技术要点”部分花费极大的精力,“看了又看”,而对其它看似非常简单的东西,重视不够、不仔细,一扫而过。经验表明,研发人员编写产品资料中,诸如芯片封装图、引脚排列、芯片视图(俯视图还是底视图)等这类越是简单的东西,出错的几率越大,对用户的影响也更大。

    我以前开发一款产品时,经历过2次这样的教训。该产品最初定位在便携产品,用QFN40的封装,后来芯片出来后,情况有变化,改为尺寸大一些的LQFP44封装,面向家电产品,但手册没有来得及更新。在设计Demo板时,尽管应用工程师已经拿到LQFP44芯片,但还是依照datasheet,将PCB按QFN40来设计,而相关人员在检查PCB设计时,也忽略了对芯片封装图的检查,结果,好不容易等PCB加工回来后,才发现不能使用,造成改产品的市场推广工作至少推迟了近10天的时间。第二次类似的事发生在深圳的一家客户身上,把QFN40封装的应用图误看成LQFP44的应用图,PCB板做好之后,才发现芯片焊不上,尽管客户承认是自己工作失误,但我们的产品手册同样有误导客户之嫌,如果我们的手册写的更细致一些,将2种封装的应用图都画上去,很有可能就会避免这次错误的发生。可见,手册编写不是小事,弄不好对客户、对自己都会造成损失,我们的态度要摆正,要重视。

    在编写文档时,除了避免低级错误外,我们还必须学会站在用户的立场考虑问题。手册是写给客户看的,不是写给自己看的,必须站在客户立场,充分考虑通俗易懂的表达方式。一个常见的误区是,“自作多情”的以为客户什么都懂,没有充分认识到客户水平的差异性;在内容的表述上,喜欢从一个抽象的概念跳到另一个抽象概念,没有由浅入深、由表及里逐步展开,让读者感觉非常的突兀,像读天书,不知所云。其次,要注意突出重点,关键的地方图文并茂,让人一看就懂,次要的地方,言简意赅、一笔带过,客户毕竟不会花大量的时间和精力来研究我们的手册。另外,写产品手册不需要文采,就是写说明文,越直接、越简单越好,尽可能使用简洁、精炼的语言来表达。有些手册让人看了非常着急,围着一个问题绕圈子,三句话还落不到点子上,“你究竟要表达一个什么意思?”,这中间反映出作者思维缺乏条理性。客户看不懂,所有的问题,最后只有通过技术支持来解决,代价太大了!

    最后,文档的规范性也非常的重要,同一公司的产品,采用统一的模板、格式和风格来写,给客户的第一印象就是“这家公司做事非常规范”,对提升公司形象非常有利。

 总结一下,我想表达的内容,一个四点:
 (1) 产品资料是产品的一部分,关系到方方面面,必须重视;
(2)学会站在客户的立场来写文档,不是以“我”为主,以技术为主;
(3)内容正确是关键,杜绝“低级错误”,;
(4)文档要突出重点、言简意赅,格式规范。

看过了觉得好的顺手顶一下啊,走过路过,不要错过!

 

评 论
17楼 xidian123 发表于 2009/4/9 23:03 回复
好多国内的芯片公司,写的文档都是美式中文,让人看了很郁闷。。写英文的吧,又不愿意向国半和ADI学习。。俺的上家就是个例子。。
16楼 52RD网友 发表于 2009/3/30 15:49 回复
忠哥太有创意了,写的文章最吸引人的是照片,哈哈。。。
15楼 52RD网友 发表于 2009/3/30 13:24 回复
忠哥,大家注意力都跑你的照片上了,猛的一看我还以为是阿宝呢,哈哈,眼神不好,眼神不好!
14楼 paul(游客) 发表于 2009/3/29 21:34 回复
是一员猛将,没看,拿着棍子呢
13楼 derek(游客) 发表于 2009/3/29 21:13 回复
崇拜!!
12楼 FireBall 发表于 2009/3/29 17:16 回复
张忠,这个名字怎么听都象古代一员猛将.
11楼 paul(游客) 发表于 2009/3/29 06:26 回复
Cool hero, go awinic!
10楼 52RD网友 发表于 2009/3/28 20:02 回复
太对了,看看飞思卡尔的i.MX 系列那烂文档,初一看还以为是小学生写的。
9楼 52RD网友 发表于 2009/3/28 11:29 回复
忠哥好酷啊!
8楼 52RD网友 发表于 2009/3/28 09:15 回复
帅哦帅哦^^
7楼 52RD网友 发表于 2009/3/27 23:57 回复
走过路过了
6楼 52RD网友 发表于 2009/3/27 22:52 回复
说的很有道理,为客户考虑的比较多!! 中间拿根棍子的那哥们是谁啊,太JB帅了,哈哈哈哈
5楼 52RD网友 发表于 2009/3/27 22:45 回复
中间那个人太威猛了!古代居然还有眼睛这个东东?不可思议哦!
4楼 steven(游客) 发表于 2009/3/27 22:41 回复
好文章,好的手册能够正确的引导客户使用产品,同时也减少救火的成本,用艾为的芯片最让人放心
3楼 马歇尔他哥(游客) 发表于 2009/3/27 22:37 回复
写的太好了!产品手册的质量确实反映出厂家的能力和水平。现在有些公司的产品手册实在太差了,一看就是抄袭别人的东西,甚至抄都抄得漏洞百出,他们的产品怎么让人放心使用。
2楼 52RD网友 发表于 2009/3/27 22:29 回复
我顶你个肺阿!!!!
1楼 52RD网友 发表于 2009/3/27 22:17 回复
好文章,中间拿把剑的是谁,尽然还带个眼镜
博 主
进入marshel的首页
博客名称:艾为之家
日志总数:923
评论数量:2792
访问次数:2287293
建立时间:2009/2/3 13:15
导 航
公 告
You win, we win, all win! 客户需求是艾为存在的唯一理由! 新浪围脖:http://t.sina.com.cn/awinic 有空来看看
评 论
zwww1212艾为哪颗FM LNA IC 呢?(2-18)
52RD网友孙总这个造型变化很大啊(1-3)
yuzhouyouling天啊。。推荐日志里全是艾为的软文。。。。(12-5)
xtwang1016加油!努力!(10-25)
52RD网友虽然不恰当。。。蛮装逼的(9-29)
52RD网友写得不错(9-18)
caiqing07104感谢楼主分享, 技术贴!(9-12)
caiqing07104感谢楼主分享!!(9-12)