发新话题
打印

[赏析] 《未雨绸缪——理解软件配置管理》写作心得( 此文章被查看:544次,被回复:9篇!! )

本主题由 懂你 于 2008-5-11 22:50 设置高亮

《未雨绸缪——理解软件配置管理》写作心得

“……我想把它贴到论坛上,你看可以吗?……我觉得相当精彩……这对SCMLife树立良好的写作和翻译氛围很重要”
下面这篇短文,原是应出版社的请求写的,现按懂老大的要求亦贴在这里,大家互相学习交流!
============================
==你真的打算认认真真写点东西?==
在当前国内的环境下,认认真真的写点技术上的东西,可不是件有利可图的事。别指望靠它发财,甚至,它比规规矩矩上班挣的钱要少。再考虑到写作是个劳动强度很大的事情,是个掉头发的事情,写作真是件匪夷所思的事。当然,事情正的一面是,写作可能会给你带来名望,进而带来潜在的经济收益。但是,恐怕这些仍然不足以解释,为什么要写作,而不去搞点股票或者房产。
我常想到这个问题,在写这本书之前,也在写这本书之中。我是在家全职写这本书的。中午的时候,溜出来到成都小吃里去吃盖浇饭。等菜的时候,心里盘算一下上午写的东西能换几盘盖浇饭,相比去上班,亏了几盘盖浇饭。算来算去,忍不住嘟囔一句“靠!”。然后吃饱了回去下午继续写。
在我看来,写作乃是人之本性之一。人类文化的传播和传承,知识的积累,靠什么?很重要的,靠写作。如果没人写作,决不会有我们今天的生活。正是因为人类有表达和记录的天性,所以才有今天光辉灿烂的人类文明。当然,如果你不这么想,也没关系,你只需要扪心自问一下,“我真的有这个Passion(激情、愿望)么”?这需要一个肯定的答案。
写作,如果开了头,却没坚持下去,这实在可惜。然而,如果是胡写,那就是可恶了。国内这样的可恶的事太多。七拼八凑、质量低劣、错误百出的书太多。这样的东西,贻害四方。轻者浪费了读者的时间和金钱;重者误导了读者,将书中的观点付诸实施时,对企业,本质上是对社会造成损失。所以,在这里恳请大家,如果写东西,那就一定要有责任心,要对书的质量负责。
=======================
==你真的有本事写一本书?==
你有东西可写么?有多少东西可写?是单独写一本书;还是与人合写,作为一章;还是写个小短文,投到网上或杂志上?一般来说,写一本书,意味着在书的内容所涉及的专业领域,你有足够多的内容想表达也值得表达,你自己的头脑里已经有了一套思想体系,你自己已经把事情基本上想明白了、想清楚了。
事情的另一方面,是写作本身的能力。通俗地讲,不光要肚子里有货,这货还得能倒得出来。写作能力的核心是表达能力。能把事情说明白不?能吸引别人看不?而对于写一本书这样的宏大工程,表达能力中,篇章结构组织的能力就变得特别重要。
要测试以上两方面的能力,一个建议是,先写点小东西,投网上或杂志上试试看,看看反响。虽然短文写得好不一定意味着长文写得好,但如果短文都写不好,那就不要尝试长的了。平时,多写点短文投投稿;在单位,把Email写得认真些、把Training做得好些,这些也都是对自己的锻炼,有助于等你想写本书的时候,能把书写好。
还有一点,就是时间问题。你得保证你有充裕的时间来写作,不然容易无限期拖延下去,半途而废。最好是能规划出一整块时间,比如,持续一两个月都集中精力在一本书的写作上。因为写作是个连续性的事情。写作需要一定时间才能“进入角色”,开始工作。这有点像把硬盘里的程序load到内存里,然后运行。如果写作断断续续,就会效率很低,写出来的东西质量也不高。如果一两个月这样的整块时间很难做到,那也最好是能利用上一段时期的大部分业余时间。比如,在几个月的时间里,工作日每天晚上能写两三个小时。周末休息日每天能写六七个小时。不过,这样是很辛苦的。
==============
==篇章结构设计==
先要写提纲。这事儿谁都明白 要注意避免两点,一是提纲太粗糙。寥寥数语,一两个小时的准备,就打算开始写书了。这肯定不行。另一个极端是,把提纲写得太细,在提纲上费的时间太多。等到真正写到那部分的时候,又发现其实不能这么组织。
一个比较好的办法是,先有一个一两页纸的粗略提纲。按章分,每章有个标题和一两句话的大致描述。还可能有点儿注意要点啥的。而在真正开始写这一章的内容之前,再进行细致的结构设计。好处有下面几个。其一,这样的组织方式(先粗后细),便于一开始着眼于做好整体规划。其二,随着前面章节的写作完成,可能会对后面的章节适当调整。如果后面章节的提纲已经太细,对提纲调整的工作量就比较大。其三,在具体某章节写作之前做详细规划,进入状态,紧接着进行写作,一气呵成,效率比较高。
其实做好篇章结构的设计常常不是件容易的事。这一方面是表达的结构的困难,另一方面也是知识体系结构本身的困难。上面说的,只是process/procedure(流程/过程)方面的经验。具体篇章结构怎么组织,这里就比较难描述了。至于本书(《理解软件配置管理》),首先划分成了两部分,上篇是基本概念体系,下篇是若干高级话题。对于上篇,重在建立基本概念、思维方法,是基础。从最简单的事情开始,循序渐进讲解,便于读者顺序阅读学习。同时,每章各有侧重,集中讲清楚几个知识点。而对于下篇,按照不同的话题来组织,读者可以在有特定需求时有目的的挑选着看。
完成一项任务、从事一份工作,常要综合考虑多个方面。就好像家庭主妇出门逛超市,可能既买了食品比如一袋面粉两条鱼,又买了炊事用具锅碗瓢盆,可能还买了筒牙膏,出了超市又买了份报纸。而写作则首先要完成相反方向的工作,把事物的多个方面分别描述出来,并深入探讨。比如,第一章,在家做饭概述。第二章,炊事用具。第三章,食品原料。第四章,采购方法与流程。第一节,超市;第二节,网购;第三节,从父母家拿。第五章,如何洗菜、预处理。第六章,Bla Bla Bla…… 附录一,北京各大超市列表。附录二,各食品营养成分列表。而牙膏和报纸的事儿就不说了,如果这本书是关于如何在家做饭的。
===========
==如何行文==
首先是,要有意识地低估读者的智商。其实不是智商的问题,而是因为读者不是你肚里的虫子。你必须清楚地表达出来你的想法,才能指望别人理解。要把事情掰开了揉碎了讲,按照逻辑一步一步讲,不要跳步。要尽量用大白话讲,特别是在刚引入一个概念的时候。要注意把握可读性和严谨性的平衡。有时候,过于严谨,会使得行文生硬,信息冗余,不像是给人看的,像是给机器看的。
文章是给人看的。给人看,举例子常是个不错的方法。可以是真例子,可以是虚拟的例子。真例子主要是利用真实发生的事例来说服人。而虚拟的例子,主要是让读者设身处地的“实践”一下。类似的,可以适当采用一些比喻,打比方。
给人看,还要考虑让人看着高兴,要有吸引力。人是有情感的、有感觉的。适当的用一些修辞,比如设问,排比,反问,会起到不错的效果。当然,不要过犹不及,毕竟是技术性文章,不是小说散文广告战斗檄文。另外,作为我个人的偏好,喜欢加一点幽默,大概是因为我平时就爱犯贫。
关于图例。要画图。如果你时间和能力都有限,那就画那些最essential(核心)的图,并且用尽量简练的方法画,比如用Word画。通常,这是20/80的事。(20/80法则:20%的投入,80%的收益。这是帕累托/齐普夫分布最著名的体现之一。)当然,如果你对画图有偏好,那做得精美些则更好。
===========
==管理版本==
嘿嘿,这是我的老本行,所以在这里说两句。
要常按Ctrl-S。如果你的PC和你的MS Word很少出问题,那就每小时按一次。如果时不时出问题,那就每几分钟按一次。
在写作过程中,保存历史版本。在‘我的电脑’里Ctrl-C,再Ctrl-V,生成‘复件(n)XXX’。举手之劳。至少每天一次。在篇章结构重大调整之前,在删剪内容之前,也应该Ctrl-C/V一下。
在写作过程中,每周向Internet上传一次,或更频繁。可以上传到你的FTP,或者你的Email的网络存储区域,或者其它地方。总之,上传到网络,以防止或减轻你的PC机硬盘坏掉给你造成的沉重打击。
一旦与他人开始交互,比如评审,或合作写书,那么每个传送的版本,必须清晰的标识版本号。简单地,可以把版本号体现在文件名里。这是防止版本混乱的基本方法。
MS Word提供了文档文件比较功能。必要时使用。
============
==沟通与协作==
写书并且出版,不是一个人的事。这是一个项目,有Partners(合作者),有Stakeholders(利益相关者)。写作不是件由着性子来的事情。多交流,多沟通,了解彼此的需要,更好地相互配合;早交流,早沟通,以免歧路走得太远,难以挽回。这方面的沟通交流,集中体现在写作的早期和中期。
另一方面,出于作品质量的需要,需要请其他同志来做评审。要请外行或者初学者来作评审,这是为了保证言语的通顺,文章的通俗易懂。要请内行专家来作评审,以便从专业的角度,发现问题,或启发思路。要请出版方面的编辑/专家来作评审,以保证内容和风格符合预期。这样的评审,主要发生在写作的中期和末期。

就写到这里了。愿大家都能写出好作品!



© 本文为 流水先生SCMLife 共同所有,未经同意,请勿转载 ©如该文侵犯了您的版权,请联系管理员
欢迎访问俺家http://www.dongyue.name

TOP

希望所有中文化项目组成员,旗帜团队成员。所有希望将来写书、写一本好书的朋友都能仔细看看,从董越的写作心得里获取一点灵感。

SCMLIfe今后也将出台制度鼓励大家营造一种严谨的,求学,著书的氛围。为配置管理行业,为整个软件工程行业的发展贡献一份自己的力量。



© 本文为 懂你SCMLife 共同所有,未经同意,请勿转载 ©如该文侵犯了您的版权,请联系管理员
优惠购买Rational,Telelogic,Hansky产品,企业VIP服务、实施
VIP服务电话:13581809377

TOP

很仔细的看了一遍;
写的非常好!!
至少自己没有想过这么多这么周全;
因为自己也没有写过书,
或是长篇小说;
平时写一些文章最长的好像目前都还没有一篇能超过1w字的;
所以总是平时也就定一些腹稿就好了;
如果真要写一些长篇的东西,
那真的要好好盘算一下;
流水先生给了指亮了一盏很好的照明灯;
有机会倒是真想写点大头的东西,可惜时间似乎总是很少!!
理想和现实总是有一定的距离的,
不是么?!



© 本文为 CMStrugglingSCMLife 共同所有,未经同意,请勿转载 ©如该文侵犯了您的版权,请联系管理员

TOP

引用:
原帖由 CMStruggling 于 2008-5-12 19:15 发表

理想和现实总是有一定的距离的,
不是么?!
努力做个追逐梦想的人:-)

© 本文为 流水先生 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员
欢迎访问俺家http://www.dongyue.name

TOP

仔细拜读了,非常全面
平时自己写点东西确实没有这样思考过,难怪效果不好
学习。

© 本文为 SCM519080 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员
交流》》让我们一起进步、成长。。。

TOP

学习精神了  
先把我的jira日记系列短片完成在说

© 本文为 wangwen 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员
子曰:唯变更乃不变也
子曰:唯进度与美女难追也
子在川上曰:BUG如斯乎

TOP

引用:
原帖由 流水先生 于 2008-5-12 23:17 发表


努力做个追逐梦想的人:-)
毕竟自己也只是个普通人,
不可能超凡脱俗;
什么事都需要有回应,
现实和梦想之间,也许只有现实才能给予我们回应!!
期待吧,
期待一切可以更好一点..

© 本文为 CMStruggling 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员

TOP

与其期待不如 硬着头皮厚着脸皮上 自己主动去争取

© 本文为 wangwen 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员
子曰:唯变更乃不变也
子曰:唯进度与美女难追也
子在川上曰:BUG如斯乎

TOP

看过您书中精彩的节选,期待着这本书的上市

© 本文为 沙漠飞雪 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员
为受难的同胞们祝福,祈祷……

TOP

引用:
原帖由 沙漠飞雪 于 2008-6-23 11:53 发表
看过您书中精彩的节选,期待着这本书的上市
据我所知,这本书已经上市了哦。

© 本文为 CMStruggling 所有,未经同意,请勿转载
©如该文侵犯了您的版权,请联系管理员

TOP

发新话题