今天上午,我拿着支付中心的设计文档,给入职不久的同事讲解目前支付中心系统的应用部署情况.当时同事嗯嗯地点头反应. 下午呢,发现自己设计的有问题,赶紧给予完善. 代码重构方面讲究DRY编程原则.我们在设计流程图.时序图.应用架构图.计划.接口文档等等,同样要遵循这样的原则.让人一看就能比较明白,必要的环节只需简单的解释即可,而不用每次都重复地讲解一遍.——文档设计得不完整或存在欠缺,也会给别人的理解造成困惑. [原文档截图] [更改后] DRY(Don't repeat yourself),"不要…

api文档设计工具是用来描述和辅助API开发的. 一.RAML https://raml.org/ https://wenku.baidu.com/view/9523238d5ef7ba0d4b733b16.html### RAML(RESTful API Modeling Language 即 RESTful API 建模语言)是对 RESTful API的一种简单和直接的描述.它是一种让人们易于阅读并且能让机器对特定的文档能解析的语言.RAML 是基于 YAML,能帮助设计 RESTful…

在上一篇文章中有介绍,产品经理的两项主要职责包括:对产品机会进行评估,以及对开发的产品进行评估.而定义即将开发上线的产品,则需要借助产品需求文档,来进行产品的特征和功能描述.PRD文档的写作会因公司.团队以及个人习惯而异,没有标准的规范和统一模板,但有三大原则是不可忽略的:文字简练.中低保真.测试验证.本文仅陈述个人对产品需求文档的理解,若有不正确的地方,还望多多指教. (一)PRD的定义.主要构成及用处 简而言之,产品需求文档(Product Requirement Document),是将商…

Vsdocman是一个优秀的.NET源代码注释编写工具,方便的以GUI的方式设计.NET源代码的注释. 我们知道.NET源代码的注释是Xml格式的注释,在生成程序集时,只需用选中生成Xml注释,Visual Studio根据源代码生成Xml注释文件.把程序集和相应的Xml文件拷贝到其它电脑中,在Visual Studio中编辑引用类型时,Visual Studio智能提示会提取Xml注释中的内容以方便编程开发. .NET Xml注释的强大功能不在此多讲,我们来看一下Vsdocman提供了哪些功能…

前言 本文主要介绍了一种新的开发思路:通过反转开发顺序,直接从API文档中阅读代码.作者认为通过这种开发方式,你可以更清楚地知道文档表达出什么以及它应该如何实现. 如果单从API文档出发,由于信息量不足,通常很难了解它具体想实现的功能,正因为有这种假设的存在,使得经常在开发之后才会想起对文档进行完善.但这种习惯对于任何开发人员而言,都不是一个好事情,在一个项目中他们会被分配完成不同的任务,不管是什么任务,必须要准确理解每个功能后,才能找到合适的方法完成工作,而一份完善的文档的作用就是能让你更好的…

前言 本文主要介绍了一种新的开发思路:通过反转开发顺序,直接从API文档中阅读代码.作者认为通过这种开发方式,你可以更清楚地知道文档表达出什么以及它应该如何实现. 如果单从API文档出发,由于信息量不足,通常很难了解它具体想实现的功能,正因为有这种假设的存在,使得经常在开发之后才会想起对文档进行完善.但这种习惯对于任何开发人员而言,都不是一个好事情,在一个项目中他们会被分配完成不同的任务,不管是什么任务,必须要准确理解每个功能后,才能找到合适的方法完成工作,而一份完善的文档的作用就是能让你更好的…

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

0. 前言 近期忙于和各个银行的代收接口联调,根据遇到的问题,对之前编写的接口进行了修改,需求收集和设计接口时想到了方方面面,生产环境下还是会遇到意想不到的问题,好在基本的执行逻辑已确定,因此只是对接口进行了一些微调,但是收钱无小事,之前在代码编写时对参数进行了很多的校验,代码修改之后一个参数的对不上都会导致接口调用的失败,所以接口文档也要进行修改.正好趁此机会利用swagger对接口文档进行了重构,记录一下搭建过程,也借此谈一下对接口设计及文档编写的一点心得. 1. 项目中添加swagger插…

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

1 schema设计原则 1.1 关系型数据库的三大设计范式 第一范式(1NF)无重复的列 第二范式(2NF)属性完全依赖于主键 [ 消除部分子函数依赖 ] 第三范式(3NF)属性不依赖于其它非主属性 [ 消除传递依赖 ] 参考:https://blog.csdn.net/zhangminemail/article/details/56834253 1.2 选择Mongodb需要考虑 读写比例.查询语句是否复杂.是否需要聚合函数.数据量 数据基本单位是什么 RDBMS:表 键值数据库:键指向的值…

在前2篇文章这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧 和这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧!(第二辑)中,大伙热情高涨.再次拿出自己的私货,在.NET平台处理文档相关的开源组件.文档处理在开发中是一个非常常见的任务了,例如导出Excel,导出Word,生成PDF报表等等.那今天就看看下面这些.NET开源项目你知道不?如果有用,千万不要忘记推荐哦.同时个人能力有限,希望大家补充. .NET开源目录:[目录]本博客其他.NET开源项目文章目录 本文原文地…

每个文档都是自包含的数据单元,是一系列数据项的集合. 每个数据项都有一个名称与对应的值,值既可以是简单的数据类型,如字符串.数字和日期等:也可以是复杂的类型,如有序列表和关联对象. 每个文档都有一个全局惟一的标识符(ID)以及一个修订版本号(revision number). 存储格式:JSON 字段解释 _id : 全局惟一的标识符,用来惟一标识一个文档: _rev : 修订版本号,用来实现多版本并发控制(Multiversion concurrency control,MVVC): _att…

保障可维护性的主要诀窍是遵循DRY原则和Shy原则. 在一个系统的整个生命周期里,理解和改动这类维护工作的比例一般非常之高.为了维护的方便,要尽量将系统划分为可以独立理解与改动的模块.这就要在设计的时候注重DRY原则与Shy原则.不过,这两条原则有一定的冲突,并不总能兼得,于是在追求的时候要重视分寸. 维护者的两大困扰 有两种情况会给维护者增添很大的麻烦:一种是为了调整一个效果,要改动无数个地方:一种是只改动了一个地方,却影响了很多效果. 在前一种情况下,非常容易出现漏改的问题——因为需要改动的…

转自:http://blog.csdn.net/hukeab/article/details/2944675   保障可维护性的主要诀窍是遵循DRY原则和Shy原则. 在一个系统的整个生命周期里,理解和改动这类维护工作的比例一般非常之高.为了维护的方便,要尽量将系统划分为可以独立理解与改动的模块.这就要在设计的时候注重DRY原则与Shy原则.不过,这两条原则有一定的冲突,并不总能兼得,于是在追求的时候要重视分寸. 维护者的两大困扰 有两种情况会给维护者增添很大的麻烦:一种是为了调整一个效果,要改…

一.背景 E.F.Codd在1970年首次提出了数据库系统的关系模型,从此开创了数据库关系方法和关系数据理论的研究,为数据库技术奠定了理论基础,数据库技术也开始蓬勃发展.而随着几大数据库厂商陆续发布的商业数据库管理系统几乎都支持关系数据模型,数据库技术逐渐统一到以关系型数据库为主导. 2001年后,互联网技术迅速发展,数据量迅速膨胀并并大,人类逐步进入大数据时代.大数据给传统的数据管理方式带来了严峻的挑战,关系型数据库在容量,性能,成本等多方面都难以满足大数据管理的需求.NoSQL数据库通过折中…

查阅相关文献并总结了在产品生命周期内比较重要的四类文档—BRD.MRD.PRD.FSD各自的含义以及用法. BRD 1.含义:BRD(business requirement document)— 商业需求文档 2.作用:商业需求文档主要用来阐述产品的宏观方向,包括产品的定位.核心价值和作用.发展方向等.为产品定型. 3.作者:商业需求文档的作者一般是项目负责人.老板或者产品总监 4.工具:PPT最为常用 5.地位:商业需求文档在四类文档中居于核心地位.它基本决定了产品的未来 MRD 1.含义:…

1. 索引(_index)索引:说的就是数据库的名字.我这个说法是对应到咱经常使用的数据库. 结合es的插件 head 来看. 可以看到,我这个地方,就有这么几个索引,索引就是数据库,后面是这个数据库占用多大空间,以及里面有多少条docs,也就是里面有多少条数据. (下面这些话算是我从其他地方复制官话吧.可以参考,但是,看完的效果不敢保证.) 索引(index)是Elasticsearch对逻辑数据的逻辑存储,所以它可以分为更小的部分.你可以把索引看成关系型数据库的表(湿胸我反对,你家的数据库一…

该文档是Testerhome官方翻译的源地址:https://github.com/appium/appium/tree/master/docs/cn官方网站上的:http://appium.io/slate/cn/master/?ruby#about-appium 中文Appium API 文档 第一章:关于appium 1.1 appium客户端 客户端类库列表及Appium服务端支持 这些类库封装了标准Selenium客户端类库,为用户提供所有常见的JSON 格式selenium命令以及额…

Atitit 项目文档规范化与必备文档与推荐文档列表 ===========比较重要的必备文档========== 项目组名单通讯录( 包括项目组,客户沟通人等 需求文档 原型ui文档 开发计划表 项目源码与架构文档以及新结构文档 设计文档 (一般概要即可,重点模块单独详细设计) 数据库文档 注意事项 =========对开发比较重要的文档 Svn源码服务器账号密码 测试数据库账号密码信息 数据库sql脚本文件. 开发环境搭建文档 项目技术规范文档.(项目模式和产品模式有很多不同,需要单独分离)…

在前2篇文章这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧 和这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧!(第二辑)中,大伙热情高涨.再次拿出自己的私货,在.NET平台处理文档相关的开源组件.文档处理在开发中是一个非常常见的任务了,例如导出Excel,导出Word,生成PDF报表等等.那今天就看看下面这些.NET开源项目你知道不?如果有用,千万不要忘记推荐哦.同时个人能力有限,希望大家补充. .NET开源目录:[目录]本博客其他.NET开源项目文章目录 本文原文地…

我第一份工作的设计总监是前百度设计师,34岁,一线设计12年:今年聊天说转了产品总监,如今39岁还活跃在行业中…… 我第二份工作的部门总监是前腾讯工程师,38岁,一线开发14年:2年前在Q群里跟我们说,他上山跟师傅修行养生,神隐了(;´༎ຶД༎ຶ`)…… 设计总监哈尔滨的,开发总监青岛的,和我们一样都是北漂,无一线户口,老家二三线城市,互联网行业发展都很一般. 说起这个主要是和设计朋友们聊天,谈到两个事情: ①有人很焦虑,说中国互联网30多岁后做不下去了,我不否认这残酷现实o(╥﹏╥)o 行业精…

该文档是Testerhome官方翻译的源地址:https://github.com/appium/appium/tree/master/docs/cn官方网站上的:http://appium.io/slate/cn/master/?ruby#about-appium 中文Appium API 文档 第一章:关于appium1.1 appium客户端客户端类库列表及Appium服务端支持 这些类库封装了标准Selenium客户端类库,为用户提供所有常见的JSON 格式selenium命令以及额外的…

  这一章的例子是对<Qt Creator快速人门>基础应用篇各章节知识的综合应用, 也是一个规范的实例程序.之所以说其规范,是因为在这个程序中,我们对菜单什么时候可用/什么时候不可用.关闭程序时应该先保存已修改且尚未保存的文件等细节都做了严格的约束.而一个真正实用的应用程序,也就应该如此.   本章应用了基础篇的众多知识点,但这里只是讲解程序流程与框架,没有涉及太多知识细节的讲解.这个实例主要是对主窗口部件的应用,所以可以学完<Qt Creator快速入门>的前5章再来学习本章,…

本文主要内容:API文档提供了预测客户成功的关键路径:在代码附近的文档上进行协作可以更好地检查代码和文档文件,提高自动化效率,并专门针对文档进行质量测试:提供通用文档框架,标准,自动化和工具,以提高团队效率. 编写文档有时候会非常枯燥乏味,但优秀的文档是增加API被采用的一个很好的前提.编写出色的文档与编写代码一样需要严谨.随着API的质量逐渐成为产品增长的指标,您的文档比以往任何时候都更加重要,优秀的文档很大程度上代表创建了成功的API.API定义和文档常常结合在一起,虽然今天的API规范越来…

目录 API文档格式 文档管理方式 基于注解实现,代码和文档在一起 Swagger Api2Doc 基于API测试工具生成 Postman rest-client 独立编写文档 RAP DOClever APIDOC CrapApi 写在最后 规范的接口文档管理方式有助于提高组件协同(如:前后端分离)的开发效率,对于项目的接口说明有全局的管理视角,甚至可以方便地实现对外发布. 完善的文档管理应该包含文档格式和文档管理方式这两部分,如下一一解释. API文档格式 规范的API文档格式有助于理解,可…

使用C#动态生成Word文档/Excel文档的程序功能调试.测试通过后,部署到服务器上,不能正常使用的问题解决方案: 原因: 可能asp.net程序或iis访问excel组件时权限不够(Ps:System.ComponentModel.Win32Exception: 拒绝访问) 解决方案: .web.config添加计算机用户名.密码: <system.web> <identity impersonate="true" userName="administr…

当今大多数的团队都实现了前.后端分支.前端与后端的沟通都是通过接口来实现的(一般情况下都是webapi接口).这种情况你肯定需要一个接口查询的帮助文档,这个当然用swagger都可以实现.但做为前端开发的我们是否也应该考虑把自己写的组件以帮助文档的方式公开都团队其他人员使用.就像iview,easyui等UI组件都有自己的帮助文档.今天我们都介绍一套工具(其中某些组件经过本人的改造) 一.需要的组件 1. Hexo:静态博客生成器 2. Hexo-theme-doc:基于Hexo实现的帮助文档类…

1.相关软件下载 DBExportDoc V1.0 For MySQL 密码:znu3 MySQL Connector/ODBC 2.安装mysql-connector-odbc并配置数据源 安装略. 配置过程:控制面板->管理工具->ODBC 数据源(对应的位数)->用户DNS->添加->选择mysql odbc驱动,并配置相关连接信息. 3.启用word07宏 打开DBExportDoc V1.0 For MySQL.doc文档->点击OFFICE图标->wo…

接口文档管理工具-Postman.Swagger.RAP 转自:http://www.51testing.com/html/10/n-3715910.html 在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在紧张的敏捷开发模式下,随着版本迭代,很多接口发生了变化或者被废弃,而开发几乎不会在后期去更新这种静态文档.QA人员阅读“过期”的接口文档是一…

Zookeeper + ActiveMQ 集群整合配置文档 一:使用ZooKeeper实现的MasterSlave实现方式 是对ActiveMQ进行高可用的一种有效的解决方案, 高可用的原理:使用ZooKeeper(集群)注册所有的ActiveMQBroker.只有其中的一个Broker可以对外提供服务( 也就是Master节点) ,其他的Broker处于待机状态,被视为Slave.如果Master因故障而不能提供服务,则利用ZooKeeper的内部选举机制会从Slave中选举出一个Broker…