看到一篇文章上说：
高水平的程序员从来不写文档的肯定是乳臭未干的毛孩子，
良好的文档是正规研发流程中非常重要的环节，
作为代码程序员，30%的工作时间写技术文档是很正常的，
而作为高级程序员和系统分析员，这个比例还要高很多。
缺乏文档，一个软件系统就缺乏生命力，
在未来的查错，升级以及模块的复用是就都会遇到极大的麻烦。

请问大家：
（1）写技术文档真的需要30%这么多时间吗？
（2）工作的时候写技术文档有哪些要求或者规范可以参考？

  谢谢黑马兄弟姐妹们解答我的疑问、

我工作经验一年左右，也写过一点关于自己的项目的文档，写文档30%这个时间差不多甚至更多，在写文档之前就必须要进行的工作有 项目需求的分析、数据库的设计、项目的设计等，一个项目做的怎么样关键在于项目设计的怎么样，而不是项目写的怎么样，所以设计时大概占项目开发的35%-40%左右的时间，只要设计完成了，开发的速度我感觉还是很快的。。等这些设计时或设计完成后就必须要有一套完整的说明性的文档，供开发使用和做为交付物给客户。一般开发涉及的文档有：项目需求说明书，项目设计说明书，数据库设计说明书这些规范性的文档网上还是不少的。

这个也要看你在什么公司？很多小公司几乎没有文档，有个健全的函数说明就不错了。

梦想蓝色天空 发表于 2013-6-18 08:00
我工作经验一年左右，也写过一点关于自己的项目的文档，写文档30%这个时间差不多甚至更多，在写文档之前就 ...

谢谢前辈

韩明海 发表于 2013-6-18 08:57
这个也要看你在什么公司？很多小公司几乎没有文档，有个健全的函数说明就不错了。 ...

原来这样啊

加油吧  哥们

梦想蓝色天空 发表于 2013-6-18 08:00
我工作经验一年左右，也写过一点关于自己的项目的文档，写文档30%这个时间差不多甚至更多，在写文档之前就 ...

前辈加油

袁梦希 发表于 2013-6-18 13:30
加油吧  哥们

多谢团长鼓励、:loveliness:

其实从软件工程来看，编码仅仅占整个软件生命周期的五分之一，
需求分析，概要设计，详细设计，编码实现，测试维护
编码之前都是在做讨论分析，然后写文档说明书，
我们在做软件项目实训的时候，做的是面向过程的训练。大部分时间都在做文档编写还有画图，满满都是泪啊，到处都是规范，不断修改，
不过按照软件工程的一套套方法一步步走下去，当你实现了详细设计的时候，整个编码整体框架都出来了。。而且主要的功能也有了程序流程图，
剩下的就是照着流程图，灵活多变的进行编码
按照我们老师说的
软件=文档+编码

至于规范，每个公司都有规范吧，我们国家也出台了相关的软件编码规范，有兴趣的可以自己去看看的。
个人认为规范非常重要，规范的统一，有利于大家统一交流语言和思想，及时项目团队临时有人更替，只要新加入的按照规范走，照样可以进行
开发

pys200603027 发表于 2013-6-18 22:45
其实从软件工程来看，编码仅仅占整个软件生命周期的五分之一，
需求分析，概要设计，详细设计，编码实现， ...

很有用，谢谢、