Joel on Software(中文名叫<Joel软件随想录>)算得上是一本旧书了,但里面的建议和讨论,真的是历久弥新.特别是,Joel是个有趣.牛逼的家伙:前微软Excel的职员.Stack Overflow的创始人.Trello的创始人,以及他和他的boyfriend走入了婚姻殿堂.这本书,是Joel自己blog文章的一个精选集. Joel在这本书里谈到了很多技术性的观点,高屋建瓴地从思想方法上去讨论如何看待程序.看待公司.看待构建过程.著名的The Joel Test也出自于此. 这本…

众所周知, VS Code 是微软和社区一起开发的一款很优秀的高级代码编辑器.它不仅可以写出一手好代码,还能写出一篇好文章.利用 Markdown 就可以写出一篇排版美观的技术文章了. 而 Markdown 是一种很轻量化的标记语言.这种语言可以完成简单的文字排版工作.其实我觉得 Markdown 是一种复古类型文本编辑方式.它写的其实是纯文本,在普通的文本旁边添加一些修饰符号,标记出文字的格式信息.目前, Markdown 已经成为很多人的撰写好帮手.在程序员社区有着广泛的应用,也在新媒体编辑…

1.写前准备(思维导图): http://www.woshipm.com/?p=80070 1.在写之前,请先很区分清楚什么是MRD文档(市场需求文档),BRD文档(商业需求文档),什么是PRD文档(产品需求文档) 可查阅知乎https://www.zhihu.com/question/19655491 2.规划产品的思维导图(信息结构图) 在写作这份文档前,我们需要先做一些准备,把BRD.MRD的相关需求消化并融合规划出产品的结构图.因为这些准备工作是属于思维类的,所以我推荐使用思维导图软件(…

产品需求对产品研发而言非常重要,写不好需求,后面的一切工作流程与活动都会受到影响.转载一篇文章,关于产品需求文档写作方面的,如下: 本文摘自(一个挺棒的医学方面专家):http://www.cnblogs.com/okaimee/archive/2013/01/11/2855896.html 一.文章的摘要介绍 无论我们做什么事都讲究方式方法,写产品需求文档(以下称PRD文档)也是如此,之前我通过四篇文章分享了自己写PRD文档的一些方法,而这一篇文章主要是对之前四篇文章进行整体的摘要介绍,帮助大…

产品需求文档(PRD)的写作   一.文章的摘要介绍 无论我们做什么事都讲究方式方法,写产品需求文档(以下称PRD文档)也是如此,之前我通过四篇文章分享了自己写PRD文档的一些方法,而这一篇文章主要是对之前四篇文章进行整体的摘要介绍,帮助大家快速了解写作流程. 1.写前准备(信息结构图): 在写PRD文档之前,我们需要先罗列出产品功能的信息内容,这一步是将想法逐渐清晰的第一步,也是帮助我们接下来规划功能的辅助信息,同时也可以辅助服务端技术人员创建数据库.因为这是第一步,所以我们不需要罗列的很详细…

前后端分离的工作模式于今是非常流行了,前后端工作的对接,就离开不了API文档的辅助. 根据自己以往的工作经历,以及了解的一些资讯,API文档的建立,无非以下几种方式: 1. word文档模板 2. 第三方平台,类如postman.showdoc等 3. 框架内单独自定义一套绑定路由的结构,再解析成html页面 4. 在框架内每个路由的方法的注释块里按照规则写注释,再解析生成api文档 5. 框架内直接编辑markdown文件,再转换成html页面 根据自己的使用心得,发表一下个人看法. 1.wo…

1:乐观锁控制 ES是分布式的,也是异步并发的,我们的复制请求是并行发送的:这就意味着请求到达目的地的顺序是不可控制的,是乱序的: 如果是乱序的方式,很有可能出现这样的一个问题,新version的文档被旧version的文档覆盖掉—-数据丢失,或者直接抛异常: TransportClient client = null;​@Beforepublic void testConn(){​    try {        Settings settings = Settings.builder()  …

摘要:程序员常会说:我最讨厌别人写的代码没有文档,我也最讨厌自己需要写文档. 有一个很老的梗: 我最讨厌别人写的代码没有文档,我也最讨厌自己需要写文档. 有这种想法的程序员应该算是一个老鸟了,对于大多数程序员来说,对于他们来说: 文档是什么. 对于大规模,超大规模的项目,并且历时很长,需要大量人员协同开发的项目,没有文档简直不可想象.但是由于时间紧,任务重,大多数的项目中的开发者都没时间写文档,而且,文档也不计入考核指标,导致开发者也没有动机写文档.这就造成了很多项目都缺少规范化文档,项目的交接…

1.为什么要写Api文档 现在,前后端分离的开发模式已经非常流行,后端开发工程师只负责完成后端接口,前端页面的开发和渲染完全由前端工程师完成. 问题来了,前端工程师怎么知道后端接口的具体定义呢?答案是由后端工程师撰写. 2.写Api文档很头疼吗 答案是一定的,这对后端工程师来说,是额外的工作,编码已经很耗费精力了,这时前端工程师来催文档,不头疼才怪:),当然这也不是前端工程师的问题,都是为项目的进度着急. 3.Swagger2 现在好了,一个自动撰写Api文档的神器出现了,他就是 Swagger…

Markdown Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯.它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档.这种语言吸收了很多在电子邮件中已有的纯文本标记的特性.-- 维基百科 由于Markdown的轻量化.易读易写特性,并且对于图片,图表.数学式都有支持,目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息.如GitHub.Reddit.Diaspora.Stack Exchange.OpenStreetMap…