前言 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程

为什么不使用github的wiki而是使用mkdocs做文档管理? 目前 KSFramework 是使用mkdocs来做在线文档 而非使用github的wiki,这是为什么呢? 在windows下搭建wiki本地预览不成熟 gollum:https://github.com/gollum/gollum A simple, Git-powered wiki with a sweet API and local frontend. (一个简单的支持git wiki,提供本地预览) 在gollum的说

showdoc 是一个很不错的api 以及技术文档管理工具 环境准备 doker-copose 文件 version: "3" services: doc: image: registry.docker-cn.com/star7th/showdoc volumes: - "./showdoc_data/html:/var/www/html/" ports: - "8080:80" 启动&&配置 启动 docker-compose

问题: 不同软件/程序在网络中互相传递信息不统一. 交互不便. REST API 作用: RESTful API就是一套协议,用来规范多种形式的前端和同一个后台的交互方式. 原理: 组成/流程/规范: 遵守OpenAPI规范 软件的REST API文档 问题: 在API的迭代开发过程中,文档更新工作容易遗漏. swagger框架 功能: 生成遵守OpenAPI规范的.JSON或YAML格式的RESTful API文档. 实现: 读取嵌入到源代码中的api文档,生成api文档. swagger规范

目录 一 RAP2 二 RAP2 安装需要的环境 2. 1 Node.js 安装: 2. 2 Mysql 5.7+ 安装 2 .3 Redis 安装见文章 2. 4 后端 rap2-delos 安装 2. 5 前端 rap2-dolores 安装 三 注意事项: 错误一 错误二 错误三 一 RAP2 RAP2是在RAP1基础上重做的新项目,它包含两个组件(对应两个Github Repository). rap2-delos: 后端数据API服务器,基于Koa + MySQLlink rap2-d

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

git地址:  https://github.com/thx/RAP wiki : https://github.com/thx/RAP/wiki/home_cn 视频教程: http://thx.github.io/RAP/study.html 官方Demo地址: http://rap.taobao.org/org/index.do 什么是rap 1.工具帮助我们更高效的管理接口文档GUI工具 2.可以自动生成Mock数据.校验真实接口的正确性 3.结构化的API数据,避免更多重复劳动 用户场

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

博客地址:http://www.moonxy.com 一.前言 在 Elasticsearch 中,对文档进行索引等操作时,既可以通过 RESTful 接口进行操作,也可以通过 Java 也可以通过 Java 客户端进行操作.本文主要讲解基于 RESTful 的文档索引与管理方法,后面章节再讲面向 Java 客户端的编程方法. 使用 RESTful API 时,主要有如下四种方式可以选择: 方式一:可以使用终端中的 curl 命令,如果还没有安装,按照系统的不同,执行不同的安装命令,CentOS

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

系列目录 基于WPF重复造轮子,写一款数据库文档管理工具(一) 本篇重点 上次发表了基于WPF重复造轮子,写一款数据库文档管理工具(一) 得到不少人支持,文章一度上到了博客园推荐表首页,看来大家对这个工具还是很喜欢.今天就继续来分享一下我在开发这款工具的过程中积累的一些技术点. 本篇主要讲的是基于HandyControl控件的DataGrid进行数据绑定以及如何实现自定义一个自定义控件.在写这些之前我们先来看下我们工具的整个界面: 今天我们要实现的就是右边主界面展示的列表区域,其实这个区域是由多

今天我们来讨论Mobox文档管理软件中的文件外链是什么?熟悉MOBOX的朋友们应该知道,如果有文件需要分享给其他同事,直接可以进行文件共享.对方会在AM的即时通讯客户端有消息提醒,点击消息提醒可以看到分享的文件. 那么既然文件的共享啊分发啊都可以通过这么便捷的方式来进行,为什么还要做生成文件外链? 其实所有的文件共享啊分发啊,这些的前提是,对方必须是你所创建的组织结构内的一员才能收到相关的消息提醒,但是假如你要共享文件的对象是你的客户,而这个客户并不在你们的组织结构之内的话,你共享的时候就没有办

今天我们来讨论一下,mobox文档管理软件中的在线编辑的这个功能,相信这个功能是用户在日常的文档维护中非常需要的. 文档管理软件的诸多功能中,在线编辑是一块很重要的功能点,因为在线编辑可以说是提高工作效率的最主要的功能点,没有之一. 很多文档是需要及时更新,做内容的增加或者删减,如果下载修改再上传,这是一个很繁琐的过程.所以在线编辑是一个非常必要的提高工作效率的功能. Mobox文档管理软件的在线编辑分为三个部分:个人网盘,协同区,单位部门文档柜. 在个人网盘中,选择文件双击,则该文件下载并被打

前言,这是自己第一次写一个系列的文档,本来想使用SharePoint 2013版本,但是碍于SharePoint 2013对于硬件要求过高,自己的笔记本无法承受,所以退而求其次选择了在SharePoint 2010版本上做文档管理的Demo.当然,由于个人认知.水平有限,博客所涉及的深度有所欠缺,但是也希望能够给一些做这方面工作的人带来帮助,也分享自己在工作之余的一些心得,一共做了如下几篇博客. 1.SharePoint 2010 文档管理系列之准备篇 介绍:创建网站集.文档库.列表库,简单的库

前言:正如我们前面介绍的是,文档管理就是让大家更加直观.方便的对手里的文档,进行统筹掌控,哪些文档是有价值的,哪些文档更受大家欢迎,所有就带来了这个星级评论. 当然,这个是SharePoint 2010自带的功能,可能会有不尽如人意的地方,大家还是选择性使用吧~~~~ 一. 文档库准备: 1. 新建文档库,如下图: 2. 开启“等级设置”功能: 3. 启用等级设置的界面,如下图: 4. 可能遇到的报错,如下图(参考5-7步): 5. 创建User Profile Service Applicat

前言:很早自己就想写一个系列的文章,但是不知道写什么,最近在QQ群里,好多人说在做文档管理,其实文档管理也是SharePoint的一个很不错的功能点,自己想了想,也想多学习点东西,所以写这个主题吧,今天从最简单开始. 一. 网站集准备: 1. 新建应用程序,创建网站集(模板 企业 - 文档中心): 2. 创建好的网站集显示如下: 我们可以看到,新建的网站集快速启动包括一个库和一个列表. 二. 网站定制 1. 修改网站名称.说明.徽标(修改徽标时,可以测试图片可用): 2. 然后我们发现,网站徽标

api(接口)文档管理工具 欢迎光临:博之阅API管理平台  ,做为一个app开发者,还没有用到api管理工具,你就OUT了 点击进入:程序员精华博客大全  

API文档管理工具-数据库表结构思考. PS: 管理工具只是为了方便自己记录API的一些基本信息,方便不同的开发人员 (App Developer, Restful API Developer)之间的工作协调,同时也是由于本人不擅长word文档编写,程序及设计简单,大牛勿喷! API基础信息表 CREATE TABLE API_Infor ( ApiID uniqueidentifier PRIMARY KEY ,ApiCategory int ,ApiSupport nvarchar() ,A

文档结构管理 以网站集-网站的方式建立各部门的文档管理中心,让文档管理更加规范,使用户更加方便地进行浏览.查找和使用文档资源. 文档全生命周期管理 结合定制开发的工作流平台对文档的全生命周期(创建.获取.存储.版本化.索引.过滤.分发.发布.搜索.归档.销毁等)进行快速.有效的处理,实现对企业文档及知识资产的完整管理. 文档在线浏览和编辑 文档库使用Office Web App功能,支持Word, Excel, PowerPoint,OneNote等文档的在线浏览与编辑功能 全文检索功能 平台支

在我们在 SharePoint 端设计文档管理解决方案之前我们要了解目前客户在他们已有的系统里是怎么对文档进行使用和管理的.只有了解了当前的使用情况才能根据客户的需求量身定做一套适合他们的有效的解决方案. 那么该怎么样搜集相关的信息呢?经过实践我们发现,如果直接去问他们:你们是怎么样使用文档的?我相信大多数时候我们得不到想要的答案.通常的回复是:我也不知道.或者是十分概括.那么就需要我们去帮助他们了解他们的使用方法以达到我们共同的目标. 整体说来:有一下几个方面的信息我们要搜集. 1, 当前文档

随着“大数据”时代的到来,越来越多的人们对数据库管理信息抱有认可态度,这是近年来信息化发展的必然结果.企业作为推进社会经济发展的主力军,也必然要紧跟大数据时代潮流,利用计算机技术全面普及企业的信息化管理及发展,才能不至落伍. 文档作为企业的智慧信息的载体,在企业发展中扮演着重要角色,文档的数字化管理是企业紧跟信息化发展潮流的重要途径.运用计算机技术进行企业电子文档管理和应用,标志着文档管理的现代化,然而企业要想实现文档的规范化管理,光靠人力是远远不够的,必然要借助文档管理工具. 在大数据时代的推