64
2023-09-13 07:41
admin一、程序员 如何高效阅读英文文档？
可以先把整个文档所要讲的东西去网上查下大致了解下，然后再去读文档，会起到事半功倍的效果。其实我们去看文档的时候只有一小部分是我们需要的，很大一部分都是我们曾经看过甚至思考过的东西。所以不管是英文还是中文也就只有一小部分我们需要着重思考，那么既然不多我们就边看边查啊，遇到不懂的词语不管是中文还是英文都要去查。
二、如何写好技术文档？
宣传一下自己写的东西，虽然感觉一点也不完美。
1. 一图胜千言（http://www.ituring.com.cn/article/17520）：
2. 大声朗读自己写的每一行字，不爽的、不通的，改之。
3. “最好的文字来自经常的修改。”
三、程序员喜欢什么样的需求文档？
一、产品简介
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加密技术，登录及相关操作时的各种精密验证，达到更
五、程序员只会技术的后果？
做程序员最需要的就是熬得住，有时候你努力了很长一段时间可能一点好的结果都没有这是很正常的。所以就看你的耐心怎么样。
如果你仅仅是有激情，想进入这个行业尝试，那做为前辈来说我还是奉劝你打消这个念头，到IT里面做程序设计是很辛苦的，很多时候你脑子里想的只有代码，其他的都不记得了。
生活不规律，睡眠不足这些都是家常便饭。所以，如果你想进来，那请你做好充分的思想准备，很多只有激情的年轻人，最后都是以放弃告终的，千万要想好，半途而废只会浪费光阴。最后，做程序员是有前途的，这个前途不是停止在程序员上，而是不断的往上走，比如成为工程师、架构师、分析师等，这些才是更高的你需要去奋斗的目标，千万不要只做底层的程序员，不然就停止进步了。
六、C 语言的技术文档在哪下载？
c语言技术标准是有开放标准的，目前在open-std官方网站上可以找到c完整标准技术文档，但这种技术文档一般对技术实现细节规定，适合研发编译器技术团队阅读。
针对一般c开发者标准库文档有部分c爱好者实现的cppreference和cplusplus，还有各编译器厂商实现的标准库技术文档，主要包括GNU glibc库和微软技术实现文档。
c技术放标准链接如下：
open-std：JTC1/SC22/WG14 - C
微软参考:C 语言参考
cppreference C标准:https://en.cppreference.com/w/
cppreference C国内镜像:C 参考手册
GNU c参考：http://www.gnu.org/software/libc/manual/html_mono/libc.html
c语言参考:C library - C++ Reference
七、腾讯文档前端使用了哪些技术？
- 1 -
场景
CHM是英文Compiled HTML Help的缩写，是微软公司专有的联机帮助格式，由HTML页面、索引和其他导航工具的集合组成。这些文件被压缩并部署为二进制格式，扩展名为.CHM，用于编译HTML。CHM格式通常用于软件文档。
虽然CHM格式是老的文档格式，很多Windows程序已经不再将它作为帮助文件的首选，但是有些场景我们依然希望将DITA或者Markdown发布成CHM格式的内容。尤其是为运行在Windows操作系统下的软件提供离线帮助。DITA发布体系支持将DITA内容发布成CHM格式。
本文分析将DITA或Markdown格式的内容发布成CHM格式的方法，并为实现这个目的扫清实际操作遇到的技术障碍。
- 2 -
DITA-OT发布框架
DITA-OT是DITA内容发布的开源发布引擎。它的诞生，是为了将DITA格式的内容发布成多种格式输出。
随着这些年的发展，DITA-OT支持的输入内容包括DITA和Markdown，输出的格式包括PDF、HTML和CHM格式等。见下图（源自DITA-OT官网：http://www.dita-ot.org）：
1. 输入格式一：DITA Map + Topic
系统支持由XML格式的DITA Map和XML格式的Topic组成的文档，见下例。
Map文件内容：
Topic文件内容：
发布过程是这样的：
2. 输入格式二：DITA Map + Markdown
同时，系统也支持由XML格式的DITA Map和Markdown格式的Topic组成的文档，见下例。
Map文件内容：
注：目前DITA-OT不支持使用Markdown来写DITA Map文件，只支持使用Markdown编写Topic。
上例中格式mdita表示Markdown格式的DITA Topic。
Markdown格式的Topic内容:
提示：在发布过程中，如果Topic格式是Markdown，系统先将它转换成XML格式的Topic，然后再执行发布。
发布过程是这样的：
如果你所在的公司有很多Markdown格式的内容，想将他们组合在一起发布，那么通过这种方式可以将Markdown内容纳入DITA发布体系，获得单一数据源多种格式输出的能力。
- 3 -
实践
因为CHM是微软公司独有的格式，只能在Windows操作系统上运行，所以请在运行Windows操作系统的电脑上运行本实践步骤。
1. 安装必要软件
如果安装了Oxygen XML Editor编辑器，它已经包含了DITA-OT发布引擎。
如果没有使用Oxygen XML Editor编辑器，那么可以自行到DITA-OT官网（http://www.dita-ot.org）下载安装程序，并按照文档安装到电脑上。本文使用的是DITA-OT 3.7.4版本。
无论用到上边两种方法的哪一种，都需要额外安装一个软件叫做HTML help workshop。这个软件是微软公司开发的，但大家可能会发现微软公司的官网已经下载不到这个软件了。
幸运的是，有其他人也碰到了此问题，并提供了解决方案。请访问如下网页：
点击网页中的下图链接下载安装程序：
下载后，请运行这个安装程序安装HTML help workshop软件。
2. 使用Oxygen XML Editor发布
在Oxygen XML Editor编辑中打开ditamap文件，然后发布，如下图：
系统会生成xxx.chm文件。双击此文件，打开结果如下图：
3. 使用Windows命令行发布
如果没有Oxygen XML Editor并且安装了DITA-OT，则使用Windows命令行发布。
1) 打开Windows命令行
2）运行以下命令
注：C:\dev\dita\dita\cloudphotox是我ditamap文件所在路径。
第二行命令的意思：
- -i cloudphoto.ditamap：输入文件是cloudphoto.ditamap
- -f htmlhelp：输出格式为htmlhelp
- -o out：输出文件放到out目录下
3）输出结果为out目录下的cloudphoto.chm文件。
打开以后如下图：
- 4 -
总结
通过本文描述的总结和实践，大家可以使用此方法将DITA和Markdown格式的内容发布成CHM格式的帮助文件。赶快试试吧！
Infomagic 学院近期热诚推出“DITA文档发布与样式定制训练营”，跟随大龙老师深入了解DITA-OT，成为DITA文档发布与样式定制专家！
\ | /
infomagic
更多内容
从火爆全网的ChatGPT，看生成式AI在技术传播中的应用前景
更多培训
文档工程师新手预备营技术传播能力地图信息架构训练营2023一起学DITADITA结构化写作训练营（基础班）（回看版）技术写作企业定制培训
八、程序员应该如何面试，程序员面试问什么技术？
程序员在面试的时候，通常会被问什么问题呢？今天就跟大家分享几个：
1、请你简单做个自我介绍
2、String类为什么是final类型的？
3、HashMap的实现原理底层结构了解吗？
4、聊一下Java内存泄漏的问题 查询定位一般怎么定位这种问题
5、SpringMVC的原理
6、介绍下Spring里面的事务管理
7、Java多线程里面，start方法和run的方法的区别
8、Java里面的线程池的原理
9、聊一聊数据库里面的悲观锁跟乐观锁
10、所做的项目中用到的设计模式
11、系统在高并发情况下处理多个大数据量请求时候，怎么去设计系统
以上就是给大家的分享，希望对广大程序员的求职面试有所帮助！
九、技术文档写作几点建议？
任何新技术，新方法的文档和书记都大致分为两类。
第一类是官方手册，是白皮书，对该技术有最权威的解释权，由技术提出者维护。此类文档一般只是枯燥的记录功能条目，其作用等价于字典（没人会拿着字典从第一页看到最后一页看完）。优点是给该技术提供了一致的解释权，该技术对于使用者有根基可循，缺点是相对枯燥不适合用来技术传播。
第二类是技术使用者根据自己经验写的类似于“最佳实践”的材料，里面融合和作者个人看法，相对比较生动，组织也很吸引人。优点是有想法，适合用于技术传播，缺点是比较主观，个别观点未见得准确或者说有偏见。
当两部分材料结合在一起就能发挥最大的作用。
下面分享几点技术文档写作建议（中英文），通用于上述两种。
1. 应尽量避免使用“你”，“We can”，“You should”这样的称谓，取而代之应该使用“用户”，"Users"这种更通用的称谓。
2. 尽量多使用忽略动作发出者的被动句子。
3. 在引用代码和脚本时候应使用特殊字体标出，必要时还原其在开发环境中存在时的色彩。
4. 文中特殊名词应该用黑体或者粗体标识出来，以提醒读者此处是一个专有名词，而非宽泛的叙述。
5. 当在文中用中文提出一个行业名词时，尽量在后面用英文写出其原文，让已知此概念读者方面对照，并告知不知此概念读者此概念非你所造而是有出处。
6. 尽量少用“可惜”，"unfortunately"这种带有主观情绪的形容词和副词。
7. Bullet或者Numeric列条目时，动作要使用原型动词引导的祈使句，比如 Create a new account.
十、产品技术文档包括哪些？
技术文档，Technical Documentation，技术文档分两类，一类指开发中要用到的研发文档，一类是给客户看的客户文档。
文档中详细记录产品的研发目的，开发阶段，研发时限等。阅读对象一般为了解项目，有一定基础的工程师。文档作为项目执行的参考，为项目的如期完成，项目质量跟踪，以及项目的后续发展等问题提供了可依据的文字上的依据。