以构架师的方式撰写技术文档(程序员提高篇)

软件工程的贯彻执行,逃脱不了文档支持。文档使事情清楚明了,有助于事前的思考,有助于事中的跟进、交流,有助于事后的总结。
然而,技术人员大多对文档撰写深恶痛绝。要么一再推卸,事后补上;要么草草了事,交给文档撰写人员去包装。

我以为,编写技术文档是一大乐事。无论是作分析还是设计或是测试,我都愿意随时文档同步。

因为如果你是在认真地写,在编写文档的同时,你会站在文档客户(看文档的人)的角度,考虑以何种方式、何等内容把事情阐述清楚,在这个过程中,你自己的思路自然也被整理得更加清楚了。一旦事情说清楚了,以后的各方交流就有了基础,不会产生误会,其实是提高了效率。

工欲善其事,必先利其器。下面,我就讲述我在编写WORD文档时,必定使用的法宝技巧。(我发现我曾向我几乎所有的技术、非技术同事介绍这个技巧,因此我想大约大部分看到这篇贴子的人都会为它感到高兴的)

你在编写文档时,是否愿意首先搭建文档的构架,再开始往里面填充内容呢?
如果是,FOLLOW   ME.
你是否痛苦地搭建构架,比如设定某行的字体为3号,加粗,以次作为某级标题,然而在需要更改标题的子从关系时,又要痛苦万分地重新设置FONT呢?
如果是,FOLLOW   ME.

选择WINWORD主菜单TOOLS(工具)的CUSTOMIZE(自定义)项,在POPUP窗口中选择COMMANDS(命令)页,并在该页面左侧的LIST中选中VIEW(视图)。

接着,在该页面右侧的LIST中,往下寻找,你会发现一组蓝色的箭头,分别为PROMOTE(升级),DEMOTE(降级),DEMOTE   TO   BODY   TEXT(降级为正文),MOVE   UP(上移),MOVE   DOWN(下移),就是他们了!

把这组按钮一个个拖到你的WINWORD的工具栏上。关闭POPUP窗口。现在,我们来HAVE   AN   EXPERIENCE。
1.   新建一个WORD文档。
2.   选择WINWORD主菜单EDIT(编辑)项里面的DOCUMENT   MAP(文档结构图),可以看到,WINWORD窗口左侧有一空白栏。
3.   在文档中敲入‘TEST1’。
4.   把光标停在TEST1所在行,用鼠标点击刚才CUSTOMIZE的PROMOTE(升级)按钮。看到了吧,在文档结构图中,出现了 'TEST1 '。
5.   在文本区的 'TEST1 '所在行回车,另开一行。并敲入‘TEST2’。
7.   把光标停在TEST1所在行,用鼠标点击刚才CUSTOMIZE的DEMOTE(降级)按钮。可以看到,在文档结构图中,出现了 'TEST2 '。并且‘TEST2’比 'TEST1 '靠右一些。不错吧。
8.   现在,按照上述方法,把 'TEST2 '进行PROMOTE(升级),不用说了吧!

这个技巧很简单,但的确使我们的文档编写方便多了。你可以从容地把文档构架设计到爽为止,再开始填入繁琐的内容。只要构架清楚,怎么填都不怕啦。

注:如果你没有先作构架的习惯,这个技巧就不能向你体现她的所有价值啦。

你可能感兴趣的:(以构架师的方式撰写技术文档(程序员提高篇))