说明文档撰写的3个步骤和7个要点.docVIP

说明文档撰写的3个步骤和7个要点 　　一直在纠结一件事情，操作手册该是产品写还是运营写，结果还是落在了产品的头上，生平第一次写操作手册，一个功能很庞杂的在线软件教育平台，以下分享一下制作过程中的血和泪。 　　 　　按步骤来： 首先，需要把系统摸得很透彻　　这个项目之前不是我经手的，我是人后妈，没啥感情，人亲爸跳槽去了别的公司，留下孤苦伶仃的项目孩儿(。)?） 所以说项目的始终性很重要，不是你亲生的，带起来那叫一个累！ 抓住一切机会向项目经理求教！　　项目经理是继产品经理之后对这个项目了解最深的人了，问底下的程序员，通常得到的结论就是........ 反正就是说不清，还不如直接跳过 项目经理告诉我平台的主要功能亮点，之后我就开始编写操作手册。　　step1：操作手册第一点就是平台简介，通常这东西没什么人回去看，但是也不乏那么两三个闲的没事干的回去撇两眼，所以简介一定要写的简洁明了、通俗易懂，把项目的特色功能最好是分段拎出来单独夸它一夸。 　　step2：功能架构图，这个部分很重要！通常商务拿操作手册给客户看的时候客户都是看看架构图，后面的内容都是以走马观花式的略过，所以这可以说是封面之后的第二张脸，超级重要，不论是内容还是美观性都要求很高。 　　推荐一个懒人方法，我用的是word2013 　　 　　很简便的一个图标制作器，文字内容添加也很方便。 　　架构图不需要阐述得过分细致，通常到达二级功能就差不多了，太过细致会显得系统很臃肿，当然太浅显也是不行的，这是真金白银卖给人客户的呀。 　　我是按照角色划分的，真实图片不便透露，大概就是这样： 　　 　　step3：因为平台的角色功能性质，所以在登录模块需要把三种角色的登录详细依次介绍 　　要交代清楚登录的网址区别，以界面不同来区分还是以tab页的选择不同来区分，要依次介绍清楚。要考虑用户的接受能力，不是每个用户都能像你一样拿着个新应用就能熟门熟路的马上上手。 　　step4：以角色名称作为一级标题，将功能作为二级标题，这样不论是电子档还是纸质的都能做到简洁明了，一眼就能却分各个角色之间的不同 　　 　　step5：介绍功能使用的时候都需要用到截图，当一张图片中同时出现多个功能点时，我使用序号来加以区分，再之后再用文字来阐述序号处的具体功能。 　　 　　step6：之后就是看你的文字功底了，不需要像写作一样辞藻华丽，操作手册讲究的是实用，所有的词语要求白话式，就是识字的人都能懂的样子。 　　step7：格式问题！一开始写的时候没把它放在心上，想着只要目录是清晰的内部格式等写完之后再来调。等到我写完之后才悔不当初，看着整洁的目录，然后是大小粗细乱七八糟的内容的时候头都大了。因为格式问题，这份操作手册就在我和商务之间过手无数遍，自己做的东西通常自己找起茬来都很困难，就像自己的孩子都是完美的，会挑三拣四的都是别人的妈。 　　 　　这时候word的格式功能尤为重要，百般修改之后我一狠心把全文的格式统统改成了正文形式，然后再新建各个目录级的样式、图片样式、内容样式等等，一顿折腾之后总算是大功告成了。 　　提到格式就必须得提到排版问题。操作手册中会出现很多的图片，图片大小不一，所占的篇幅也不一样，所以会出现某段文字之后是一大片的空白，下一页开始就是一张硕大无比的图片，这样影响美观，也关乎成本。所以图片该缩小的时候就不要心软，可以调整图片的嵌套格式，使其尽量贴近文字，实在不行的话就把之前的图片适当的放大一点，使其底部的空白处减少。 　　操作文档看着简单，其实要求作者对系统的全面了解，每个细节都要解释到位是一件很困难的事。为我以前扔在一边的操作手册们道歉ε(┬┬﹏┬┬)3 　　提醒一下各位产品亲爹们，善始善终！中途撂挑子走人是一件很不道德的事情！ 　　作者：YuanYi