原文:程序员编写技术文档的新手指南

这是一篇帮助你给第一个项目写文档的指南。 万事开头难,我希望这份指南能把你引导到正确的道路上。 最后,你应该有一个可以公开发布的项目。 请轻松地阅读完这篇文章,或者简单地把它当作参考。 为什么要写文档 你将会在 个月后使用你的代码 我发现一开始从利己的角度来解释这个问题会比较有吸引力。写文档最好的理由就是你将会在 个月后使用你的代码。你 个月前写的代码跟别人写的代码对你来说通常没有什么区别。你将会 ...

2018-08-14 12:24 0 12161 推荐指数:

查看详情

Toxy新手指南

Neuzilla出品 官方网站:http://toxy.codeplex.com QQ群:297128022 官方微信公众号: Toxy 是干嘛用的?它是.NET平台上的文件抽取框架 ...

Tue Mar 17 21:24:00 CST 2015 21 3704
Grunt 新手指南

导言 作为一个正在准备从java 后端转大前端,一直都有想着,在js 的世界里面有没有类似于maven或者gradle 的东西..然后,就找到了grunt 这玩意 Grunt是用来干什么的 ...

Sun Sep 01 07:01:00 CST 2013 0 4640
一份关于npm的新手指南

Node.js使得在服务器端使用JavaScript编写应用程序成为可能。它是基于V8Javascript运行时并且使用C++编写的,所以它的速度很快。最初,它旨在作为应用程序的服务器环境,但是开发人员使用它创建工具来帮助他们进行本地任务自动化。从那时起,一个全新的基于Node的工具生态系统 ...

Fri Jul 28 18:26:00 CST 2017 1 6420
OmniGraffle-新手指南

OmniGraffle是一款不错的可视化软件,通过它你可以把你想要展现的数据简介、直观的展现在图、表上,这是我在数据可视化工具这篇随笔中说过的功能。但是当我真正用它时,我发现它可以做的事情还有很多。 用来绘制实体关系的ER图,用来绘制程序流程图,甚至我当时苦苦寻找的思维导图软件,发现其他的都收费 ...

Fri Mar 18 17:48:00 CST 2016 0 7195
Airtest新手指南大全

了这篇新手指南大全,希望可以帮助大家可以更好地理解和学习这俩个自动化测试框架,轻松入门自动化测试。 Ai ...

Fri Apr 24 22:42:00 CST 2020 0 584
elastic-job 新手指南

大多数情况下,定时任务我们一般使用 quartz开源框架就能满足应用场景。但如果考虑到健壮性等其它一些因素,就需要自己下点工夫,比如:要避免单点故障,至少得部署2个节点吧,但是部署多个节点,又有 ...

Sun May 20 01:04:00 CST 2018 4 10521
vue-router新手指南

在学习完vue.js以及vuex之后,我们还剩下vue全家桶中的最后一个需要学习的组件,这就是vue-router了,本篇文章我们就来一起认识和入门vue-router。为什么我们只是入门呢?因为在这里我不会把官方文档中的每一个细节都讲的清清楚楚,如果需要精通,仍然需要多多阅读官方文档和自我实践 ...

Tue May 16 22:20:00 CST 2017 0 2715
币圈新手指南

、黑客攻击、技术缺陷等等因素) —————————————————————————————————— ...

Tue Jan 02 21:22:00 CST 2018 9 540
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM