摘要:老师会经常说一句话:“好记性不如烂笔头”。Leanote界面清爽干净,支持文本格式与Markdown,Markdown编辑也是所见即所得的方式。对工作日志,随时更新,随时改进...
ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!程序员都很希望别人能写技...
摄像机从舞台左边摇摄。画面中显示着一个打开了空白页面的编辑器。一个人弯着腰坐在桌子前面,头朝着桌子。 上面的场景对每个以写作为生的人来说都很熟悉,空白的页面混杂着许多情感。它充满了...
PHPer
最近几个月,我们收集了很多不同的学习资源,包括文档、指南以及很多有用的网站,可以帮你学习不同的前端技能。这里列出了一些其中非常棒的。 1. Keyboard Event Viewe...
PHP代码搬运工
大数据分析挖掘原创作品,欢迎大家疯狂转发 SignalFx以监控现代化基础架构而闻名,对来自AWS、Docker或Cassandra之类的指标进行分析,对数据实时执行分析,并启用警...
专注Hadoop Spark等大数据开源技术。
在我们的编程开发中,如果能在没有一行注释的代码中找到注释,是不是很意思呢?我们经常容易犯一个错误:我们修改了一段代码,但是忘记修改更新注释。混乱的注释并不会打断你代码的执行,但是想...
很多人说,不知道怎么写文档,都是凭着感觉写。网上也很少有资料,教你写文档。这已经影响了中文软件的发展。 英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作...
我说的都是错的
本文以jekyll官方文档为例。为小白简单介绍一下,jeyll就是一个静态博客生成器,你只要按照它给定的规则进行相关的配置后,你就可以只要专心写文章,什么数据库管理、自己搭建一个C...
前端学习中
涉及知识:gulp javascript建议阅读:4分钟 我们经常在写代码的时候要求写好注释,方便日后维护。但其实注释还有一个重要的用途:生成API文档。 文档意义API文档有什么...
《了不起的JavaScript工程师》作者;公...
软件研发的协作过程中,文档是必不可少的一环,有需求文档、接口文档、使用文档等等。当开始写文档时,首先会遇到两个问题:team members 之间如何协作?文档 OK 后如何分发,...
国内首款开源 CI/CD 工具
简介本篇文章将阐述如何通过使用我开发Parliament,与Swagger、Keyhole Software提供的工具,搭建一套自动发布、集中管理的API文档中心。背景介绍Spri...
发布人:技术文案 Jed Hartman 现在,您可以将我们的开发者文档风格指南用于开放源代码文档项目。 多年以来,Google 的技术文案都在根据一份仅限内部使用的编辑风...
欢迎关注Google开发者中文博客:devel...
Foreword在写英语技术文档的过程中,Technical Writer 必定会遇到的一个问题就是:标题到底该大写还是小写?为了便于理解,将这个问题拆分一下:标题:这里指的是一篇...
技术人员
今天和大家说一个技术团队的老问题:一个长期持续迭代的项目,代码已经翻过很多次了,但是技术文档还是最初的样子,后来的技术人员依靠文档已经无法正确了解项目最初的样子了。或者是,技术文档...
工程师
在阅读本文之前,您先需要了解Swagger的使用,如果您还不知道它是用来干嘛的,请先阅读《Spring Boot中使用Swagger2构建强大的RESTful API文档》一文。前...
Spring For All社区发起人之一,国...
在服务端开发过程中,我们需要提供一份 API 接口文档给 Web 端和移动端使用。实现 API 接口文档编写工作,有很多种方式,例如通过 Word 文档编写,或者通过 MediaW...
| 京东金融-移动研发部-前端开发工程师 在css的世界,文档没有被得到充分的利用。由于文档对终端用户不可见,因此它的价值常常被忽视。另外,如果你第一次为css编写文档,可能很难确...
程序员
说起 Fuchsia,这个直到现在一直被认为即将取代 Android 的新一代操作系统,相信相当一大部分人对此或多或少有所耳闻,毕竟 Google 已经半秘密式地开发时间将近两年...
微信公众号:安卓笔记侠
本文将着重介绍交互设计师的输出物–交互文档的相关细节,enjoy~在经历了互联网行业飞速发展的今天,行业步伐逐步减慢,互联网公司的架构和开发流程也随之日益完善,产品开发工作也变得具...
作为一名软件工程师,我花了很多时间在阅读和撰写设计文档上。在磨砺了数百篇文档之后,我发现,优秀的设计文档与项目的成功之间有着密切的联系。这篇文章将介绍怎样才能写出一份优秀的设计文档...
关注服务端技术
作为一名开发者,可能经常遇到这种问题,项目进度太紧,当你在编写一个Rest 服务时只能将时间都放在编码上,文档基本靠口口相传。 作为一个团队管理者,API文档优先非常重要,比如你需...
关注微服务前沿技术,探索云原生领域的热点话题:...
fine -- generate your document site in 3 secondsfine 目前仍旧处于测试版本,我们会不断补充更多的功能,同时也尽可能的提高它的健...
在两年前,我提到了怎么去做 API 文档,这在这两年来以来效果不错,问题有,只是都不是很大,因为我们内部都已经形成了习惯。但是,情况开始变化,尤其是在被 CTO 骂了之后。目前的流...
后端码农,偶尔拍拍照,骑骑车,撩妹技能 LV0
需求文档版本清晰化,充分利用Git 的版本管理能力,轻松对比不同版的修改演进。减少在文档格式排版上的投入,争取简历上不再有精通word。充分利用开发者既有工具,减少工具量,少就是多...
创业者,阿里云MVP,NPDP认证,PMP认证...
在上一篇文章——《细说API – 重新认识RESTful》中介绍了如何理解和设计RESTful风格的API,现在我们来聊聊如何有效的呈现API文档,以及前后端协作的方式。我经历过一...
README.mdOverAPI OverAPI 是一个可快速访问API文档浏览的扩展 -> 前端 first !!! InstallNode.js > 8.0 and Type...
程序员/机车党/隐居山野的农夫
结构化的知识可以很方便的用于推理中,但是从非结构化的数据中获取结构化的知识表示,这一过程非常困难且成本高昂。本文假设浅层的语义知识和其暗含的语义信息是可以获取,且能够用于问答系统的...
慧技术·惠金融
Wizard 是一款开源文档管理系统,项目地址为 https://github.com/mylxsw/wizard。这个项目是 我 在2017年就开始开发的,起初只是想做一款能够在...
一个在外漂泊的人
上篇博客,介绍了性能测试从零开始实施如何制定流程。开始本篇博客之前,让我们先回想下在你的工作经历中,是否遇到过下面的一些问题:1、要做接口测试,找开发要接口文档,开发告诉你没有接口...
Alone,butnotlonely!