程序员 如何高效阅读英文文档？

一、程序员 如何高效阅读英文文档？

可以先把整个文档所要讲的东西去网上查下大致了解下，然后再去读文档，会起到事半功倍的效果。其实我们去看文档的时候只有一小部分是我们需要的，很大一部分都是我们曾经看过甚至思考过的东西。所以不管是英文还是中文也就只有一小部分我们需要着重思考，那么既然不多我们就边看边查啊，遇到不懂的词语不管是中文还是英文都要去查。

二、程序员喜欢什么样的需求文档？

一、产品简介

1.简要说明产品的使用价值

我是谁（一两句话写清楚产品的身份）？

我有什么用（我是做什么的，我能提供什么服务等）？

为什么选择我们（与竞争对手相比，我们产品的优势，核心竞争力是什么）？

2.目标用户、使用场景

产品的主要用户群是谁？

用户主要在什么场景下使用我们的产品。

二、行业概要

简要阐述行业现状

未来的发展趋势

竞争对手情况分析

补充：如何快速了解一个行业？

1.通过艾瑞咨询、易观等网站查看行业的分析报告，深入了解整个产业的上下游结构；

2.通过商业模式画布工具，分析行业主要玩家的商业模式

三、版本

按照版本来分类，点击版本链接可进入查看每个版本的文档。

文档的第一页如下图：

（一）、排期

每次的大版本开发，最好对应有一个排期表（与开发沟通确认时间的安排），开发过程中，根据进度情况，适当调整时间安排。

开发人员可以根据自己负责的模块，进入排期详情查看当天的任务，完成的模块可以进行标记，如图。

（二）、产品设计（重点）

1.实体关系图

当你做的产品是从0到1时，为了让数据库的开发人员更快速的了解你的产品，实体关系图（E-R图）将会发挥很大作用，数据库的开发人员可以参考此图来做数据表结构的设计（具体这里就不说了，大家可以网上详细了解E-R图）。

厂家、经销商、客户等这些都是属于实体，实体包含的的属性（字段）最好也要写出来，如下图举例：

2.用户角色权限表

涉及到角色和权限的，需要做一份全面的角色权限表格，方便开发人员参考。

3.业务流程图

通过业务流程图，可以在大方向上知道产品的整体逻辑，业务流程图拆解可以得到任务流程图，任务流程图拆解可以得到页面流程图。

4.全局说明

一些通用的控件、状态等，不需要每次都说明，比如空数据、网络异常、加载失败、刷新状态等等，只需说明一次即可。

5.需求、功能、交互说明

很多人在写功能说明、交互说明时，总是会遗漏一些细节，逻辑不严谨。从以下几个维度去说明，将会让你考虑的更加全面：

字段、字段说明、数据来源

前置条件、排序机制、刷新机制

状态流转（一个页面可能有多个状态，需要说明）

交互操作（正常操作、异常操作）

下面，笔者将以一个页面做举例说明：

产品设计模块里的结构如图：

（为了方面查看以及和视觉页面的对照，每个页面需要标注编号）

（三）、非功能需求

1.埋点需求

页面的打开率、按钮点击率等，如果需要记录，则需要做说明。

埋点是数据分析的基础，建议使用“GrowingIO” 这个工具进行可视化埋点，操作简单、方便，能减少很多的工作量。

2.性能需求

请求数据的响应时间要求、并发数要求等。

3.兼容性需求

系统版本的支持、多终端的支持、浏览器的支持等。

（四）、修改记录

文档的第二页如下图：

为了让开发人员更方便的浏览，增强阅读体验，使用markdown语言来辅助写需求文档是最好不过了，浏览体验会大大提升。

程序员必读书籍

这里有份程序员各方面齐全的经典书籍，有需要的话可以下载下来看看：

三、程序员开发文档怎么写？

1.1.1 项目名称

项目名称（项目类型）

1.1.2 项目开发者

成员一：**

成员二：***

成员三：***

1.1.3 项目开发环境

MyEclipse ＋ Tomcat5.5和MyEclipse（自带）＋ SQLServer 2005

1.1.4 系统功能设定

品红商业网分为2大模块：

1.前台系统

## 设定新闻，商品以及购物相关功能：

NEWS：对新闻的增加、删除和查询操作，并且增加上下条功能进行查询，以及最新新闻的显示与增加。

PRODUCT：对商品的增加、删除、修改和查询操作，并且增加分页技术进行查询，以及最新商品的展示与增加；增设对商品的选购，打印清单、结算功能。

TALKING：用户之间的在线聊天，进行互动交流，洽谈业务，对信息发表自己的看法等，并设有广告介绍，让用户了解最新信息。

MESSAGE：客户留言薄，针对各种商情，业务交流进行离线留言，站外，站内用户可以通过此信息及时了解最新资讯，了解用户反馈信息等。

ABOUT：介绍了公司对客户的信心，诚意做出了诚恳的表态。

AFTER：介绍了公司关于商品的售后服务条例等，给客户提供更满意的服务。

COPYRIGHT：介绍了公司的版权信息，以及法律授权及其相关。

2.后台管理系统

## 设定对管理员，用户以及管理员对新闻和商品信息的相关操作。

ADMIN：对用户的查询和删除，对新闻的增加，删除和查询，对商品的增加、删除、修改和查询，都增设了分页技术更有规范的查询。并附有时间，让操作人员在任何时候都能得到精准时间，以提高管理员的时间观念。

1.1.5 项目开发技术

JSP + JavaScript + HTML

1.1.6 设计思路

通过相关技术，一一实现对管理员，站外，站内用户，公司新闻信息，商品信息进行实用的操作。

1.1.7 项目背景

本着为客户提供最优质的服务，项目从多角度考虑需求，以求达到客户所需要的功能，实现零距离的操作。

1.1.8 主要模块讲解

1.1.8.1 模块一

1. 名称：管理员模块

2. 简介：管理员的登录，对相应信息操作

实现了管理员对用户，管理员的操作：

1. 对用户的查询，删除（必要的删除），使用分页技术给管理员更好的视觉效果。

2. 添加管理员使用了MD5加密技术，登录及相关操作时的各种精密验证，达到更

四、程序员英文不好，看不懂英文文档怎么办？

看不懂怎么办？都2022年了，那么多翻译软件，只要硬着头皮看，就不信看不懂。

就说我吧，不瞒大家，我英语四级没过，但还是照样能看英语资料，照样和别人一起翻译了国内的第一本 Hibernate 技术书。

当初我用 Hibernate 在国内算是比较早的一批程序员了，也经常去论坛回答问题，所以后来就有人找我一起翻译书。我最开始是抗拒的，觉得自己英语太烂了，翻译不好。后来我又想，既然我能看着英语文档学 Hibernate，要不就试试。于是就这么着干了一把。

我想说的是，技术文档没有特别复杂的语法、生僻单词，而且现在还有翻译软件、插件可以帮我们阅读。

相信我，即使英语基础一般，看英语文档也不是一个无法克服的困难！

u1s1，新技术我推荐看英语资料。但是很多人的英语水平就是那么回事，不可能达到像中文母语这种水平。所以，对于很成熟、经典的可以看中文资料，比如一些中文技术书，翻译确实不错，人家译者也花了大量心血，质量也是杠杠的。

在这里推荐一份中文的“豆瓣高分计算机书单”，程序员必备，几乎都是8分以上的好书。

书名后面的数字，是豆瓣评分。详细内容和pdf免费下载方式看这个（有需要下载的尽快了）

计算机的书很多，读不好的书又浪费时间又浪费钱。这份书单就像名字一样，希望帮大家少走弯路。

再推荐两个我经常去的国外技术社区：

Stack Overflow

Stack Overflow - Where Developers Learn, Share, & Build Careers

全球最活跃的程序员技术问答交流社区，程序员的所有问题都能在上面找到答案。

Medium

https://medium.com/

建议大家有多多去看看，既可以多练练英语阅读能力，又可以学知识，一举双得！

五、程序员为什么都不喜欢做文档工作？

其中的原因很多，我自己归纳了几点：

1.怕烦 程序员从入门之日起，就在心里埋藏了一颗编程的种子，认为程序员就是编程序的，就是和计算机打交道的，程序就是程序员的全部。无论是在编程之前写文档，还是在编程之后写文档。

他们都认为写文档很烦人。

1）文档种类太多。

越正规越多。一想到要写那么多的文档，程序员的头都要大了。

2）文档写作要求不低。有格式要求、内容要求，还需要画各种流程图、示意图、关系图、界面图和填写各种表格说明，以及要收集各种资料。

虽然没有技术含量，但是要花的时间比编程序多，而且也不一定能写好。

3）在正规的开发公司中一般一个变更就要编写一系列的变更文档。当不断变更时，只有最后的变更文档是最重要的。

当我们不知道当前是不是最后一个文档时，我们就不愿意写可能被后面的文档替代的文档。

4）当写了文档之后，就会不断有使用文档的人来询问细节，这些询问往往会让人崩溃。

这是因为很难写出让每个人都提不出问题的文档。

2.没空 在很多情况下，程序员都处于一种“时间紧、任务重”状态。在急于得出编程结果的驱使下，程序员一心扑在编程上，恨不得一分钟一个变化，哪有心思和时间先把文档写好再去编程呢？即使他们拥有先把程序编出来，然后再补写文档的想法，但是一旦他们完成一段程序之后，就会立即扑向第二段程序。

如此下来，编写文档只能放在项目开发的后期了。

你要是真的写文档，那写文档的时间早已将编程时间给挤占了，你的编程工作就完不成了。

3.没有用 文档的重要性其实对不同对象是不一样的。如果你说文档没有用，立即会有人用唾沫把你淹死，他们立即会搬出哪个哪个说文档是重要的，文档是不可缺的。唯独不敢说“我自己认为文档是重要的”。

这也反过来说明文档的有用性程度对不同人是不一样的。对于程序员来说，只要能把程序编出来就行了。很多程序员不写文档照样编出程序来，在他们的观念中文档不写也罢。

如果按文档编程序，那就要确保文档的正确性、不可更改性。

而实际上，文档不如编程快，编程不如变化快，不断变化的需求和代码让文档如同一张过时的废纸一样。

在现实中，有的文档变成了项目开发后的总结，对开发本身并不起作用，只是保留一个存在的形式，以应付各种各样规范的需要。

在这种情况下，文档没有任何实用价值，所以即使程序员写了，也没有什么作用。

尤其是项目投产后，几经升级，最初的文档早已和现实的情况对不上号了，文档更新和系统的一致性更是难于控制。

4.没好处 既然认为编程序才是正道，那么程序员写文档就是一种额外和辅助的工作，做了就做了，对于程序员来说没有任何好处。 当然，文档的好处更多地体现在软件公司、单位、软件用户、后续程序员身上，它是一种“前人栽树，后人乘凉”的好事。所以程序员不愿意写文档。 文档有多么重要呢？有人把它上升到“程序员头脑的拷贝”的高度，有的人甚至说，程序员走了后，只要有了文档，软件公司可以再招新人，公司照样运转起来。如此说来，天性聪明的程序员会把文档写得清清楚楚吗？ 5.不会写 从写作本身来看，写好一篇文档不是一件容易的事。文档有文档的格式和写作要求。现在的人只喜欢动嘴说事，没有多少人在平时会动笔写字，更不用说写文章了。

所以，写文档从理论上来说也是需要学习和训练的，需要在平时进行写作积累。

当要求一些程序员写文档的时候，他往往会回答你：“怎么写呀？我不会。”你不会写可以不怪你，你不去学，反而理直气壮地说不会，则是你的不对了。难道那些会写文档的人都是“呆子”吗？难道他们不懂干活辛苦的道理吗？ 当一个男子向一个自己喜欢的女子示爱，需要用情书来表白的时候，难道他不会写情书吗？即使他不会写，他也一定会克服千难万险把情书写出来的，这是他的主观使然。如果程序员主观上想写文档，怎么会怕烦？怎么会怕没空？怎么会怕文档没有用？怎么会怕不会写？这些怕其实都是借口。真正优秀的程序员应该不单是编程的高手，同时也应该是写文档的高手。 程序员真正不喜欢写文档的原因是：文档是给别人看的，不是给自己看的。如果要使程序员喜欢写文档，那就要提高程序员的意识和境界，或者要给写文档的程序员以奖励。而靠制度、管理让程序员去写文档只能是一种职业上的弊端。当有一天写文档也成为一个专业化的岗位，程序员和文档人员分开时，程序员就会一心一意看文档写代码，文档员就会以此为职业，一心一意写文档拿工资。我们将不再为此进行讨论。这种分工一定是未来的趋势。一些大的公司或管理规范的公司都已经有这样的分工了。只是很多中小软件公司或企事业单位里的IT部门还没有专业化到如此程度。程序员不喜欢写文档也许说明他们不愿意承担太多的角色吧。 不管怎么说，作为一个程序员（尤其想成为优秀程序员）一定要学会写文档，一定要学会欣赏文档。无论你是否喜欢，你都应该可以在文档的各种问题面前可进可退。可以这样说，那些既不会写文档，又不会欣赏文档的程序员是没有资格说“我就不喜欢写文档”这种话的。

六、程序员如何写一份高质量的说明文档？

所有不给用户提供产品说明文档的开发，都不是好开发。

程序员不喜欢写文档，如果有时间写文档，还不如把代码重构一遍。早前我也这么认为，究其原因，一则自己不喜欢也不擅长写文档，代码是给机器读的，只要语法和逻辑没问题，计算机就会听命执行，而文档是写给人看的，除了语法和逻辑，好文档还要照顾读者的心理感受；

二则传统软件的客户对文档无感，它仅仅作为合同约定的交付物存在，客户压根就不会读这些文档，他们更依赖我们提供的现场培训和技术支持，让客户看文档自学太不符合甲方的身份了。

但现如今大部分软件产品都通过互联网向用户提供服务了，在线文档才是最高效的客户服务通道，我们熟知的那些开源软件都配有高质量的在线文档。

好文档是优秀产品的标配，它不仅可以帮你带来更多的用户，而且还可以帮你服务更多的用户。作为互联网程序员的你，要是不懂如何写一份好的技术文档，都不好意思跟人打招呼，更别想做出好的产品。

程序员如何写出高质量的产品说明文档

一、明确帮助文档的受众对象

写产品帮助文档，如果是为了交差而写，脑袋很容易卡壳，思路无法拓展。在敲键盘之前，我们先要想清楚这份文档是写给谁看的，通过这份文档可以帮读者解决什么问题。

写作是我们输出影响力的一种能力，其最终目的是为了改变读者的信息、行为，否则就是言之无物的垃圾。等明确了目标读者和意义之后，我们的思路也就打开了。

二、简单的表述

编写技术文档的过程中会遇到哪些常见问题呢？通常我们习惯一上来就非常详尽地介绍这款产品有哪些特性，具体怎么安装、配置和使用等等...

其实大部分潜在用户都是初次接触此类产品，他对我们的产品还没有完整的认知，压根不知道这款产品到底能帮他解决什么问题，对他而言有什么价值，一上来就深入细节就很容易把潜在用户搞蒙。编写帮助文档不是简单地增加文档篇幅，尽量简洁易懂的文字，更容易被用户所吸收。

三、帮助文档内容之间的联系

帮助文档的开篇必须要通过介绍产品或方案的价值来跟用户建立连接，让他知道这款产品的工作是息息相关的，它可以帮助他优化工作。

接下来才是让用户了解这款产品是什么，以及怎么使用。这其实跟软件研发的流程类似，从用户需求开始，先分析梳理用户的痛点，再到产品需求，设计一款产品来解决用户的痛点。

四、合理的排版结构

当我们明确了文档的目标读者，也明确了可以为读者解决哪些问题，写作本身就有了指向和价值。在此基础上，我们就可以开始考虑文档应该包含哪些内容，目录章节该怎样安排设计才更符合用户的学习规律。

文档就是我们对外输出的一个产品，做产品就要学会换位思考，站在用户的视角考虑他们需要什么样的产品或方案，文档的章节目录设计要围绕用户需求，同时需要注意新老用户的引导，以及常见问题的设置。

五、故事思维让文档不再枯燥

我们对故事类信息的接收会更加高效一些。如果你干巴巴地罗列产品功能特性，就像传统的产品使用说明书一样，那用户在阅读这份文档时是无感的，他会觉得枯燥无味、困难重重，无法将产品跟他遇到的问题联系起来。此时，我们就需要采用故事思维来组织包装这些素材，结合用户的使用场景讲故事。

除了以上几点外准确的搜索、定时的用户建议收集同样重要，还需要记住的一点产品帮助文档优化工作是长期的，随着产品的迭代用户的反馈都需要做到及时的相应。

推荐一款程序员/运营都适合的帮助文档制作工具-Baklib

帮助文档工具推荐

Baklib是一款在线的文档编辑及内容分享工具，不仅为企业提供了好用的知识整理平台，还提供了优质的知识发布平台，通过Baklib制作的文档内容会自动转化成网站，通过设置的url链接就能进行访问，方便客户在线观看，帮助他们对产品的理解，为用户使用提供便利。

文档管理工具需要满足内部知识存储的同时，还需保证内容分享的便捷性。而一款好的文档管理制作工具，是需要要让内部搭建员工用得简单，外部访问的客户看着舒服。Baklib文档管理工具有以下四大优势。

1. 操作上：Baklib在操作上无需构建文档框架（每个主题都有对应的展示框架 现在的话有15个主题都是针对帮助文档场景），打开浏览器就可以用，不懂编程技术会用Word就能轻松编辑文档，随时编辑、随时更新、随时发布，让客户点点鼠标就可轻松查看。
2. 外部展示上：Baklib提供了多种对外的展示主题支持手机端的适配（手机和电脑上的观看效果一样优质），可以随意的切换变更颜色，支持页面页脚、独立域名的添加...
3. 细节：提供了很多实用的插件包括全局搜索、用户反馈功能、文章导读、帮助站点的访问统计、站点导航...
4. 编辑器：丰富的富文本+Markdown让编辑更加轻松（支持视频、图片、文件上传）

七、谁有产品需求文档，市场需求文档，商业需求文档的范文？这个文档 有没有模板可以参照？

给你个建议吧，搜索一下“先知文库”这个小工具，可以找到很多模板供你参考。

八、程序员座右铭？

程序员的座右铭挺多的，身为程序员的我先分享几个：

1、一个100行的代码调试都可能会让程序员遇到很多挫折，所以，面对挫折，我们永远不能低头。

2、每天都要优雅的写上每一行代码。

3、每个函数方法的调用都有诗和远方。

4、作为一个真正的程序员，首先应该尊重编程，热爱你所写下的程序，他是你的伙伴，而不是工具。

九、程序员段子？

一、程序猿问科比：“你为什么这么成功？ ”科比：“你知道洛杉矶凌晨四点是什么样子吗？ ”程序猿：“知道，一般那个时候我还在写代码，怎么了？”科比：“额…….”

二、女神：你能让这个论坛的人都吵起来，我今晚就跟你走。程序猿：PHP语言是最好的语言！论坛炸锅了，各种吵架。女神：服了你了，我们走吧，你想干啥都行。程序猿：今天不行，我一定要说服他们，PHP语言是最好的语言。

十、程序员口号？

，1、数据分析，抢占先机。

　　2、快速分析，洞察先机。

　　3、让网络智集需求。

　　4、数据精彩非凡，商机一目了然。

　　5、云在指尖，触手可及。

　　6、大数据高效分析，商机抢占先机。

　　7、智能数据分析，先机转化效益。

　　8、没数，做事没谱。

　　9、数据纳百川，领先在云端。

　　10、问道专业大数据，抢占市场新效益。

顶一下

(0)

0%

踩一下

(0)

0%