程序员开发文档怎么写

① 请高手指教，一个java WEB项目的开发文档要怎么写，让别的程序员一看就明白这个项目的框架是怎么工作的。

你这个问题问得不太合理，开发文档要写很多东西，而你要让程序员看懂这个项目的话，只要写交互图就可以了，至于项目的框架式怎么工作的，只要告诉程序员是什么框架就可以了，程序员应该会使用框架

② 作为程序员如何书写技术文档

按自己的喜好去写,没有具体的格式,不过要写名程序的用途,代码的函数使用方法,变量的意义等内容

③ 程序员怎样规范编写接口文档

规范的事情当然要有专业的工具。推荐使用的是docway写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

一、请求参数

1. 请求方法

• GET

用于获取数据

• POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

• PUT

用于新增数据，可与POST互换，语义上PUT支持幂等

• DELETE

用于删除数据

• 其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

• application/x-www-form-urlencoded

请求参数使用“&”符号连接。

• application/json

内容为json格式

• application/xml

内容为xml格式

• multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：



五、接口工具

推荐使用的是http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

④ 我是个编程的自学者，想当程序员不知道公司写文档是什么意思知道的情给我解释一下,还有具体是怎样工作的

以鄙人在软件公司工作的经验与你分享一下吧。
我们平时做项目，一般有一半以上时间都在管理文档，包括基本设计书，详细设计书，静态样式书，各种UML建模图，单体测试书，系统测试数，结合测试书，DB设计书，DB脚本，以及各种工具类管理文档，如资源文件管理，VBA管理等等，这还不包括项目前期的需求建设书，项目中期与客户交流的反馈书，项目后期的BUG管理书，以及贯穿项目的工程进度表和版本控制书。当然你的代码资源（包括注释，图片，脚本等）也属于文档，需要统一管理。
对于追求简短快的团队，未必会太重视文档的组织与管理，但是一定要相信文档看似浪费时间，其实无形中提高了很大的效率，而且在未来的开发提供了宝贵的参考资料。属于团队积累的一种。

⑤ java程序员需要些什么文档

我很少写文档，懒得写，除非项目有要求

对于文档这个东西简单谈一下

1. 做项目之前就有文档

   这个是可遇不可求的，现在做的项目很多都是临时突然说要做的，什么需求都没有，只能靠程序员自己去发现，项目经理的要求，客户的临时需求（这个比较痛苦，他们有时候根本就不知道要什么，所以必须写好文档，跟客户谈好，不然又要变的时候，你就痛苦了）

   如果项目一开始就有文档，当然也可能是你自己写的，也可能是其他人写好的，有些公司有人专门负责写，需求分档，项目分析文档，项目结构文档，数据库文档等等，不过之后可能需要你写测试文档，这个就没有听说过谁帮你做了，但是更多的情况也是不用写，就几个功能，自己和测试人员测测就算了，也有可能需要写使用文档，这个看情况了

2. 做项目之前没有文档

   如果项目紧张，根本就不会写任何文档，但是当项目结束的时候，你又没有项目做，项目精灵可能就让你写写文档打发打发时间，

文档对于公司来说是很重要的，但是对于个人的话，就要看情况，如果你做了很多项目，其实什么文档也不需要，你大体上都知道这个项目就做什么用的，怎么架构的，那些代码是什么意思(你的编程习惯很好的情况下)，所以很多公司都会要求程序员写文档，不然你走的时候，别的人怎么接受，让别人理解你的思想是很痛苦的，每个人的思想都是不一样的

⑥ java面试官问有没有写过文档（面试java程序员）,我想知道写文档是指什么,是设计文档还是需求文档还是其他

一般大点的公司需求文档还是不需要你去编写的，不过需要开发人员协同讨论与审批，
一般开发人员要写的是 概要设计文档，和详细设计文档之类的
至于步骤要看公司而定，有的是开发完成后才去补写这样的文档，有的是在开发前就需要
将文档写好，然后按照文档来开发。

⑦ 安卓开发程序员需要自己写开发文档吗

这个要看公司需求，如果需要还是要具备写开发文档的能力，软件需求文档格式的标准写法引言 、编写目的、阐明开发本软件的目的、项目背景、标识待开发软件产品的名称、代码、列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展。

⑧ android app开发文档怎么写

：软件需求文档格式的标准写法 1．引言 1．1 编写目的 · 阐明开发本软件的目的； 1．2 项目背景 · 标识待开发软件产品的名称、代码； · 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展

⑨ 程序员开发文档怎么写

去下载一个开发文档模板按照写就可以了