何谓"文档"?

tsym 2001-10-17 07:58:26
小弟虽从事程序设计工作,但因身处小公司,且管理水平落后,仍属手工作坊式的开发模式,我的工作就是按设计、调试程序,只要能达到要求又不出错就OK,没有其它规范要求。而我无论是看《程序员》,还是看书,都提到了“文档”的概念,而且其重要性不亚于编写代码。那么,“文档”到底是指什么呢?现在我常常把类、函数、变量等等的作用和说明记下来,以防不测。请问,这算不算是“文档”,还需有什么改进呢?
...全文
99 6 打赏 收藏 转发到动态 举报
写回复
用AI写文章
6 条回复
切换为时间正序
请发表友善的回复…
发表回复
skt985 2002-01-11
  • 打赏
  • 举报
回复
38814关注! :)
freebase 2001-10-17
  • 打赏
  • 举报
回复
软件开发过程当中,得出的产品应当有3种:数据 文档 代码
代码:产品相当于做饭最终得到的馒头
文档:相当于馒头生产说明书
数据:相当于生产馒头的经验数据

我们即使得到微软公司的Windows代码,也很难开发出Windows,因为我们不知道如何制作以及相关经验数据。

我请一个大师傅做馒头
我请一个大师傅做馒头,并要他写出馒头生产说明书--文档
我请一个大师傅做馒头,并要记录他多少面配多少水,蒸多长时间--数据

我请一个程序员做程序
我请一个程序员做程序,并要他写出需求分析,详细设计,模块说明,代码注释。。。。(别人就可以看懂了^_^)
我请一个程序员做程序,并要他留下开发功能点需要的资源,所用的时间,功能点的规模,我就知道以后做类似的项目我到底能用多长时间了,并可以加以控制了,哈哈哈


Jneu 2001-10-17
  • 打赏
  • 举报
回复
up
青润 2001-10-17
  • 打赏
  • 举报
回复
文档包括你所有需要进行记录和说明性的文字,不过需要你把这些文字组织起来成为一个整体,这时就形成了文档。
比如说:需求分析文档、类的阐述文档(包括方法、属性的说明)等等。
tsym 2001-10-17
  • 打赏
  • 举报
回复
有没有标准文档让我见识见识,d16@sina.com
多谢了.
alfal 2001-10-17
  • 打赏
  • 举报
回复
楼上的,说最终代码是生产馒头的经验方法,而数据就是那些馒头,这样说好象更好一点儿…………

1,268

社区成员

发帖
与我相关
我的任务
社区描述
软件工程/管理 管理版
社区管理员
  • 研发管理社区
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告
暂无公告

试试用AI创作助手写篇文章吧