从文档的编写问题引发的一些思考
2010-05-27 11:20
274 查看
文档的书写格式要注意,格式要前后统一,如编号、字体、段落格式等,错别字要避免。文档的内容不需要华丽的修饰,但是至少要清晰易懂,能表达清楚自己的想法,语句要通顺,不要让别人去猜你要表达的意思;对于业务性和技术性很强的文档,就更应当少用自定的缩略语和自己想当然的话,要使用一些术语和标准的用词,如安徽卡、外省卡这些我们平时可能内部讨论问题时使用的词汇,尽量不要在文档中使用,毕竟文档的读者范围未必都是我们项目组内部的开发人员,可能包括我们的领导或者客户,有些内容业务性很强,仅靠标题是无法表达清楚全部内容的,那我们就要增加一些描述性的文字,适当将主题展开叙述,才能将内容表达清楚。因此,莫要惜字如金,同时也要将词汇的选择和语言的组织重视起来,毕竟写代码不是程序员工作的全部,文档的编写同样也是十分重要的一项技能。
粘贴复制是组织文档的一个手段,但粘贴复制之后我们就认为工作已经结束了吗?我想肯定不是,粘贴的内容是否符合文档的要求,是否需要我们进行相应的调整?测试报告的前言是从以前的文档复制过来的,但是测试时间居然没有修改,我想这样的错误是不应该发生的。因此,针对粘贴复制的内容,必须要仔细检查是否需要修改,发现问题及时调整。
从文档编写的一些问题想到了代码开发实现,是不是我们也同样存在着类似的问题,我们如何看待任务的“完成”。简单的堆砌不意味着“完成”,文档写完后是否我们会去仔细的检查,代码编写完成后是否我们会仔细的检查和测试。我们经常会听到“xxx模块我已经完成了”这样的话,但很多时候它距离“完成”还那么的遥远,也许界面还都没做,也许界面点击后频繁报错,也许2天达到所谓的“完成”状态,但还需要2周的时间去完善才能真正的“完成”。因此,我们要慎重的说出“完成”这两个字,在说“完成”之前再思考一下是否我们真正的“完成”了,还有哪些需要调整和完善的内容,争取做到真正的“完成”。这样,我们的领导才能将更多的时间和精力投入到他该做的工作中去,而不是面对我们的低级错误无奈无奈再无奈;我们的测试人员才能将更多的时间和精力投入到更高水平的测试内容中去,而不是面对我们参差不齐的界面、残缺不全的功能以及频繁弹出的异常提示崩溃崩溃再崩溃。
我相信我们每个人都希望自己能有所进步,在自己从事的领域能有更好的发展,遇到问题和困难不可怕,只要我们发现问题并找到解决问题的办法,多思考、勤总结,尽量做到同样的错误不再犯,我们才能真正地进步和提高。
说了很多自己的感触和想法,大多是自己曾经犯过的错误和教训,也很感谢大家能把这么多内容读完,没有说教的意思,只是希望和大家交流一下自己的想法,希望我们做的更好。
粘贴复制是组织文档的一个手段,但粘贴复制之后我们就认为工作已经结束了吗?我想肯定不是,粘贴的内容是否符合文档的要求,是否需要我们进行相应的调整?测试报告的前言是从以前的文档复制过来的,但是测试时间居然没有修改,我想这样的错误是不应该发生的。因此,针对粘贴复制的内容,必须要仔细检查是否需要修改,发现问题及时调整。
从文档编写的一些问题想到了代码开发实现,是不是我们也同样存在着类似的问题,我们如何看待任务的“完成”。简单的堆砌不意味着“完成”,文档写完后是否我们会去仔细的检查,代码编写完成后是否我们会仔细的检查和测试。我们经常会听到“xxx模块我已经完成了”这样的话,但很多时候它距离“完成”还那么的遥远,也许界面还都没做,也许界面点击后频繁报错,也许2天达到所谓的“完成”状态,但还需要2周的时间去完善才能真正的“完成”。因此,我们要慎重的说出“完成”这两个字,在说“完成”之前再思考一下是否我们真正的“完成”了,还有哪些需要调整和完善的内容,争取做到真正的“完成”。这样,我们的领导才能将更多的时间和精力投入到他该做的工作中去,而不是面对我们的低级错误无奈无奈再无奈;我们的测试人员才能将更多的时间和精力投入到更高水平的测试内容中去,而不是面对我们参差不齐的界面、残缺不全的功能以及频繁弹出的异常提示崩溃崩溃再崩溃。
我相信我们每个人都希望自己能有所进步,在自己从事的领域能有更好的发展,遇到问题和困难不可怕,只要我们发现问题并找到解决问题的办法,多思考、勤总结,尽量做到同样的错误不再犯,我们才能真正地进步和提高。
说了很多自己的感触和想法,大多是自己曾经犯过的错误和教训,也很感谢大家能把这么多内容读完,没有说教的意思,只是希望和大家交流一下自己的想法,希望我们做的更好。
相关文章推荐
- PHP:由一些小问题引发的思考
- 软件文档编写存在的问题和解决办法的思考
- PHP保持SESSION问题以及由SESSION性能引发的一些思考
- 读本期《程序员》(8月刊)而引发的对计算机相关专业毕业生就业问题的一些思考
- 关于“JAVA中为什么没有了多继承并出现了接口”这一问题引发的一些思考
- 由802.11 隐藏节点引发的一些思考
- 由二进制翻转问题引发的思考
- 安卓中Handler可能引发内存溢出问题的思考
- 一些小问题技术笔记(一)--思考是进步的本质
- 编写第一个javascript的XPCOM,以及一些小问题的解决。
- 需求文档编写常遇到的问题?怎么破?
- 【.Net】c# 中config.exe 引发的一些问题
- <职场定位需要思考的一些问题------给大学毕业生的建议>
- 一些简单问题的思考:
- 面试中的一个小问题引发的思考
- 一个问题引发的思考
- Dephi调用C#编写的WebService的一些问题与解决
- 一个游戏引发的思考(概率问题)
- 0302思考并回答一些问题
- 0302思考并回答一些问题