javaweb开发技术⽂档的编写
技术⽂档分类：
分为开发（研发）⽂档和客户⽂档
开发⽂档：
项⽬开发过程中为了增加程序的可读性和程序的健壮性， ⽅便后期程序的调试和维护，所以需要在开发过程中统⼀技术规范，⼀般会在项⽬初期确定好相关⽂档作为这⼀统⼀的规范。不同公司会对⽂档做不同要求，划不同的分类，但⼀般来说（或者拿⾃⼰的经验说）⼤致可以分为需求⽂档、接⼝⽂档、流程图（可以单独作为⼀份⽂件可以作为附件附在⽂档中）、变更⽂件等。
⼀、需求⽂档
在项⽬启动之后，项⽬的⽬标已经明确了，那么就要开始着⼿⼲活了，但是在⼲活之前，需要对整个项⽬分析透彻。那么，如何对业务进⾏分析呢，看以下的建议。
⾸先，开发⼈员要有随意转换⾝份的意识和能⼒。
A、明确产品功能
在分析业务时，站在⽤户的⾓度上，思考要做的产品能实现什么功能。把所有的功能点列出来！
B、分析某⼀功能点的流程
在罗列了所有的功能之后，需要站在开发者的⾓度分析每⼀个功能点，考虑从客户端到后台操作数据库的整个流程，可以从是什么、为什么、在哪、怎么做、谁来做、做完如何反馈、反馈给谁、上传到哪、服务器⽤什么数据库、数据库需要什么表、表⾥有什么字段、每个字段的属性及意义等等。⽐如，我要要做⼀个软件中个⼈头像上传的功能，⾸先明确我做的是上传功能；为什么要上传？因为个⼈资料需要头像；怎么做上传？通过⽹络I/O实现；这个功能在什么位置？软件有个个⼈中⼼模块，个⼈中⼼⾥有个个⼈信息⼦模块，在这个模块⾥可以上传头像；谁上传？已经登录的⽤户；上传完之后如何反馈？弹窗提⽰上传成功；反馈给谁？客户端已登录的⽤户；上传到哪？服务器上；⽤什么数据库？MySQL；需要什么表？（存到）⽤户表；表⾥有什么字段？⽤户信息的基本字段；每个字段的属性及意义？略。在思考完这些问题之后，可以把⼀个功能点串成⼀条完整的从前端到数据库的线。
C、整合各个功能点–明确分⼯
在串完所有的功能点之后，站在⼀个⾼⼀层次的⾓度，把每个功能点之间的联系理清楚，按照相互的联系分⼯合作，优化其中的细节问题。
D、撰写需求⽂档
分⼯完成之后，按照第⼆步分析的内容，每个⼈把⾃⼰负责的功能整理成⽂档，最后合并⽂档，作为统⼀的需求⽂档。
E、绘制业务流程图
需求⽂档确定之后，绘制整个项⽬的业务流程图，这时候的流程图只需要包含前端的业务流程，后台实现的流程图不需要在需求⽂档中体现，⽽是放在后⾯的接⼝⽂档中。
⼆、接⼝⽂档
不同公司对接⼝⽂档的要求也不尽相同，但包括的内容却是⼤同⼩异的。封⾯、标题、审批页、修订历史以及格式字体等等风格迥异的次要内容不做赘述，只讲⼲货！⼲货！⼲货！
A、请求地址
需要哪个线上地址就写哪个。注意不要反低级错误，⽐如写错某个字母或者⼤⼩写问题。
B、接⼝信息
说明请求⽅式，是POST还是GET。
C、功能描述
清晰地描述接⼝功能，要求⾔简意赅，不要写太多废话，也不要遗漏任何细节。
D、接⼝参数说明
声明参数的名称，严格要求与调⽤⼀致，包括⼤⼩写；
简单说明参数的含义；
参数的数据类型，是string 、int 还是long等（例如参数为@RequestParam(“appKey”) String appKey,
@RequestParam(“randomId”) Integer randomId）；
备注部分，说明参数值是需要哪个公司提供，并详细说明参数怎么⽣成的，例如时间戳，是哪个时间段的；参数是否必填，⼀些参数是必须要有的，有些是可选参数，⼀定要注意写清晰。
E、返回值说明
有⼀个模板返回值，并说明每个返回参数的意义。提供⼀个真实的调⽤接⼝，真实的返回值。
F、接⼝调⽤限制
为了安全，双⽅采⽤⼀个⼀致的加密算法，保证接⼝调⽤的安全。
G、⽂档维护
⽂档维护时，修改内容部分需要有修改⼈、修改⽇期、版本号的信息。
三、流程图
流程图可以单独作为⼀份⽂件，也可以作为附件附在对应的⽂档中，具体执⾏按要求来。
业务流程图
程序结构图
程序流程图
四、变更⽂件
在开发过程中如果出现与预期计划、⽂档不⼀致的地⽅，则视为发⽣变更，此时⼤致需要提供以下信息：
A、版本历史（版本号、基本信息）
B、变更前现状
C、变更内容
D、影响评估
E、审批
客户⽂档：
指产品发布以后，公布给⽤户使⽤的⽂档。英⽂⼀般称为Customer Documentation。
⽂档详细解释产品的具体使⽤⽅法，安全提⽰，客户服务信息等。阅读对象⼀般为⽤户，技术⽀持⼯程师，售后服务⼈员。⽂档作为产品和市场接轨的桥梁，为产品的在市场上赢得客户的青睐，以及产品的长期发展做出了良好的保障。
要求
技术⽂档要符合以下要求:
1 针对性
⽂档编制以前应分清读者对象，按不同的类型、不同层次的读者，决定怎样适应他们的需要。
① 对于⾯向管理⼈员和⽤户的⽂档，不应像开发⽂档(⾯向软件开发⼈员)那样过多地使⽤软件的专业术语。 难以避免使⽤的词汇，应在⽂档中添加词汇表，进⾏解释。
② 开发⽂档使⽤的专业词汇未被⼴泛认知的，应添加注释进⾏说明。
③ 缩写词未被⼴泛认知的，应在其后跟上完整的拼写。
2 正确性
① 没有错字，漏字。
② ⽂档间引⽤关系正确。
③ ⽂档细节(Title/History)正确。
3 准确性
① 意思表达准确清晰，没有⼆义性。
② 正确使⽤标点符号，避免产⽣歧义。
4 完整性
① 意思表达完整，能到主语、谓语、宾语，没有省略主语，特别是谓语。
② ⼀句话中不能出现⼏个动词⼀个宾语的现象。
③ 不遗漏要求和必需的信息。
5 简洁性
① 尽量不要采⽤较长的句⼦来描述，⽆法避免时，应注意使⽤正确的标点符号。
② 简洁明了，不累赘冗余，每个意思只在⽂档中表达⼀次。
③ 每个陈述语句，只表达⼀个意思。
④ ⼒求简明，如有可能，配以适当的图表，以增强其清晰性。
6 统⼀性
① 统⼀采⽤专业术语和项⽬规定的术语集。
② 同⼀个意思和名称，前后描述的⽤语要⼀致。
③ ⽂档前后使⽤的字体要统⼀。
④ 同⼀课题若⼲⽂档内容应该协调⼀致，没有⽭盾。
7 易读性
① ⽂字描述要通俗易懂。
② 前后⽂关联词使⽤恰当。
java技术介绍百度百科③ ⽂档变更内容⽤其他颜⾊与上个版本区别开来。
④ 测试步骤要采⽤列表的⽅式，⽤1)、2)、3)…等数字序号标注。 （百度百科）

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。