java技术文档如何写(项目完成后)

问题描述

如题,之前没写过,现在不知道如何下手,请问写作的重点应该突出什么方面,是程序的设计,还是程序的使用,细节方面如何处理,要细化到每一个变量,方法嘛.请教高人!!!

解决方案

解决方案二:
你要先确定你要写什么文档吧?需求分析,概要设计,详细设计,测试报告,用户手册等等,每一个侧重点都不相同啊
解决方案三:
这些文档基本都有规范,找找你们公司以前写的文档参考下
解决方案四:
各个公司的规范可能不一样,如果公司没有这样的规范,就参考别人的写一下咯。
解决方案五:
我也没写过,扯草草、zoubalon(这个汉字打不出来)
解决方案六:
项目完成后最多写点总结,技术文档。。。不过现在基本上都是项目完成后写,哈哈不同的文档一般有对应的模板,或者找下你们公司以前写的参考下说白了跟码字差不多
解决方案七:
网上应该有吧可以参考一下我也没写过,参加软件设计比赛都要写文档。。。一般都到网上参考的
解决方案八:
该回复于2011-01-26 08:35:44被版主删除

时间: 2024-11-08 17:20:01

java技术文档如何写(项目完成后)的相关文章

写有价值的技术文档

背景 传统瀑布开发模式下非常重视文档,每个开发环节的衔接都通过文档实现.这种重视在CMMI达到了极致,软件开发的每一步从形式到内容都要求文档化,需要设计者花费大量的精力在文档的撰写和维护上.高度文档化需要投入巨大的成本,这种成本在相对固定,变化较少的问题域(如传统的制造.管理)可以从软件后期的维护收益上得到补偿,实践中也得到了较好的效果.但在变化较多的问题域(如互联网.创业企业),高度文档化会造成整个软件生产过程的反应迟滞,进而造成企业竞争力的下降.于是这些要求快速反应,快速迭代的行业逐步放弃了

MDN Web 技术文档 - JavaScript Strict mode

MDN Web 技术文档 - JavaScript Strict mode 在 JavaScript 1.8.5 引入         ECMAScript 5的严格模式是Javascript中的一种限制性更强的变种方式.严格模式不是一个子集:它在语义上与正常代码有着特意的差异.不支持严格模式的浏览器与同支持严格模式的浏览器行为上也不一样, 所以不要在未经严格模式特性测试情况下使用严格模式.严格模式可以与非严格模式共存,所以脚本可以逐渐的选择性加入严格模式.         严格模式在语义上与正

《Cocos2D-X游戏开发技术精解》一1.6 技术文档

1.6 技术文档 Cocos2D-X游戏开发技术精解前面的章节内容,曾介绍了两个包含引擎的技术文档的地方,细心的读者一定会留有印象.在引擎的官方网站,提供了在线版本的API指南.以防读者忘记了,下面列出的网址就是访问路径. http://www.cocos2d-x.org/reference/native-cpp/index.html 在引擎的下载包中也提供了技术文档.不过,技术文档的内容其实包含在代码中,读者需要一个工具才能生成网页版本.这个工具就是Doxygen.它是一个C++.C.Java

中文技术文档的写作规范

很多人说,不知道怎么写文档,都是凭着感觉写. 网上也很少有资料,教你写文档.这已经影响了中文软件的发展. 英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软.MailChimp.Apple.Yahoo.docker.Struts 等等(维基百科有一份完整的清单).中文的也有不少,但都不令人满意,要么太简单,要么不太适用. 我就动手,参考上面的规范,也结合自己的实践,总结了一份简单的<中文技术文档的写作规范>. 标题 文本 段落 数值 标点符号 章节结构

java 向文档中写入数据,格式像表格一样整齐

问题描述 java 向文档中写入数据,格式像表格一样整齐 如图,我要将一个文件中的数据解析然后产品格式如图,用Java实现,需要用到哪些包.库或者是什么工具啊,对文件操作特别浅显,请指教. 解决方案 Java提供了操作word文档的工具包,Java poi. 解决方案二: 建立和数据相关的model 类,读取数据时构造对象,存放于集合中.读取结束后.用 for 循环集合,按语言的合适将数据输出.

linux中在文件夹下新建文档属于写操作(w)还是执行(x)操作

问题描述 linux中在文件夹下新建文档属于写操作(w)还是执行(x)操作 众所周知,linux下文档和文件夹都有rwx操作,读鸟哥的私房菜中说不能在没有x权限的文件夹下执行一些命令,比如man,ll等,那在文件夹中新建文档是属于写操作还是执行操作? 解决方案 这要看你是怎样新建的这个文件,比如用 touch 来创建的文件,正常情况下就不会有x权限. 但如果你有执行gcc的权限,那么你用gcc编译一个自己写的c文件得到一个可执行执行程序时通常就有x权限了. 还有一些脚本文件,一般新建时用vi或e

java-关于Java帮助文档的使用

问题描述 关于Java帮助文档的使用 例如,我要查System.out.println()的使用方法,怎么查不到?刚学Java,求前辈科普下,谢了 解决方案 下载一个java jdk_api文件,在java.lang包中有说明. 解决方案二: 既然你能来这里提问,为什么不直接google呢?比看那蹩脚的本地文档好多了. 解决方案三: 应该是中文的吧? 你打开API后点击左上的显示 有个输入关键字查找,你输入system,点进去就找输出流了 解决方案四: 那输入流怎么没有说明怎么用?该怎么用 输入

C#技术文档

问题描述 跪求C#技术文档.要全一点的,最好像JAVA那样可以快速打开的. 解决方案 解决方案二:"C#技术文档"."快速打开"?没明白不是有现成的MSDN吗?解决方案三:借贵宝地同求,文档.解决方案四:要的是CHM文件的吧,微软现在不给做这种的了,因为有MSDN在,所以也没有爱好者去做chm了解决方案五:MSDN怎么打开啊?解决方案六:MSDN也不好用啊,毛都找不到.SqlConnection都找不到.解决方案七:开始->程序->MicrosoftDe

高分跪求infragistics和dotnetbar这两组控件的技术文档,使用说明的东西.

问题描述 各位兄台,小弟正在使用这两个组件写一些东西.非常希望能得到infragistics和dotnetbar这两组控件的技术文档,也就是介绍每个控件基本用法的文档.但是,从网上搜了N个小时了,竟然一无所获,很是无奈与郁闷.所以,在此高分跪求这两组控件的文档地址,或者发给我油箱shuaikun250@yahoo.com.cn谢谢你们了.我等你们直到天亮!!!! 解决方案 解决方案二:楼主注意身体啊.如果谁有的话能顺便发我一份么,谢谢了.我的邮箱是ishiwe@yahoo.com.cn再次感谢.