C#程序员需要什么写文档的能力?
程序员似乎都是需要写文档的吧,可我对文档实在是无力啊……希望前辈推荐一些相关的书籍或资料,最好有相关案例的,在此拜谢。
------最佳解决方案--------------------其实 文档就是对你写的代码的说明,你在设计时是怎么想的,用了什么模式,实现时时怎么想的,用了什么算法,你写出来的软件怎么使用,需要注意什么,开发文档的话 ,还要有对扩展的说明,扩展需要实现什么接口,继承哪个基类。
软件说明文档是最简单的,其实软件使用说明应该是测试来写,他们更熟悉!截图,操作流程就够了
------其他解决方案--------------------在小公司里这些一般都不注重,
在大公司里,写操作手册之类的,这些是有专人来做,
程序员把自己代码的注释写清楚点,就行了,
这样方便自己和以后的人维护
------其他解决方案--------------------
有流程有规范是好的,但运营流程是要成本的。现在的企业都追求利益最大化,‘能省能快能交付’可能就是他们的口号。撸主提到的某文档其实可能就是某流程的一个环节。要不要文档,实践了就知道...
------其他解决方案--------------------这就好比如说一个电影大片,写脚本、写宣传提纲等等,都是必要的,而且每一个部门的人都写很多文档。
但是文档都是为了及时沟通协调而用。如果说“写文档就是为了给设计思路做详细注释从而能够让以后的菜鸟导演继续创造这一个大片的续集”,我想任何编剧和导演都会笑话!我们一下子就想到了这种话是外行说的。
------其他解决方案--------------------
+1
------其他解决方案--------------------
如果要进阶写文档应该也是很重要的吧?而且程序员只需要写软件说明文档就可以吗?
------其他解决方案--------------------
需要什么样的文档,就是什么样的写法,如果是软件说明文档(一般是项目型公司才要写说明文档),只需要把软件的使用流程写出来就可以,什么样的功能需要怎么样操作,都需要文档来说明,就像是在写手机或X电子产品说明书一样!
如果是代码文档,那你所有的设计模式、算法实现、UML图、 扩展性说明等等,都需要有。
------其他解决方案--------------------你不写详细的文档,就准备被接手你工作的人骂死。
------其他解决方案--------------------其实对于 代码注释 现在流行的理念是,代码即注释。所以,代码注释可以省略大部分,然后就是设计注释,修改注释,等等都不能少的
------其他解决方案--------------------
文档,有时候可以根据代码生成的,要什么文档都可以。但是,要不要文档,得看领导的!!
------其他解决方案--------------------要你写什么文档,你就要一份以前同类型文档做参考。
不知道怎么写,就问让你写的人,直到问明白为止。
文档这个东西,没有一定之规,写呀写的就会写了。
------其他解决方案--------------------看哥哥一个软件下来 写了多少文档。。。这个还是个小的
------其他解决方案--------------------分工合理的大型项目。。其实不需要你写多少文档。。专心编好你的代码就行。。
------其他解决方案--------------------需要写。
但是把它当作代码注释的,很是垃圾。