=波波日志 > 其他 > 优秀程序员是如何来写文档=

[转]优秀程序员是如何来写文档

  程序员-----这个职业大家并不陌生,在当前IT行业盛行年代,这个职业被广大求职都所看好。因不这个职业不仅薪水好,而且办公环境更是一流。所以越来 越多的求职者想通过学习来投入到这个行业中。大连北大青鸟茂森学校作为IT人才培训基地,与大连千余家IT企业建立了良好的企业用人合作关系。每年为IT 行业输送近千名专业IT技术人员,学员遍布大连以及国内各省市和港澳地区。作为一名优秀的程序员,我们应当如何来书写自己的文档呢?

    在书写文档时我们得注意两点:

   一:简洁:能用一句话说清楚的绝不用第二句,用最简单的句子。

   二:清晰:结构清晰,让人一目了然;逻辑清晰,尽量减少读者的理解成本;重点清晰。

   对于文档的内容我们要做到以下几点:

   1、结构

   项目标题、项目引言、项目时间、项目范围、项目内容、项目计划。这几个部分缺一不可,顺序没有定式,始终如一即可。由于大部分活动文档都是用这种结构,所以制作一个活动文档的模板是十分有必要的,能够节省很多时间。

   2、重点

  语言简洁,不说废话,同时要突出重点跟。跟玩家参与活动有关的都是重点(5W1H),这些重点尽量用颜色区分,但是不同的颜色不要过多,多于3种以上的颜色就很难看。我一般在奖励(红色)和NPC(蓝色)上用颜色区分,时间由于是独立的一部分所以不用颜色。

   3、总结

  我们做程序开发工作的,每天必需要有的就是总结,总结今天做过的工作,以及整个项目完成后的工作等等。

来源:http://hi.baidu.com/%B1%B1%B4%F3%C7%E0%C4%F1%5F%C3%AF%C9%AD/blog/item/7e93dcd5c51675235882dd47.html

类别:其他 作者:转载 日期:2011-11-28 【评论:0】 
 
暂时没有评论!
发表留言
  • *昵称:
  • 头像:
  • 电子邮件: [留下您的邮件,方便管理员回复您。]
  • 个人网站: *验证码:
声明:本网站尊重并保护知识产权,根据《信息网络传播权保护条例》,如果我们转载或引用的作品侵犯了您的权利,请通知我们,我们会及时删除!
Powered by showbo,©2012,桂ICP备05005887号 京公网安备1101055090