关于开发文档

(1)官方文档
开发语言、开源框架、开源软件都会为开发者提供了非常全面的官方说明文档,开发文档大多数是自动生成的(Javadoc/Doxygen/Doxia/JSDuck),便于文档的及时更新大多数是HTML格式的。官方开发文档更全面、更权威,也不用特意去记URL,只要Google一下“xxx docs”既可以看到。

比如:
jQuery http://api.jquery.com/
Bootstrap http://getbootstrap.com/
Java https://docs.oracle.com/javase/8/docs/index.html
Spring https://spring.io/docs/reference
Hibernate http://hibernate.org/orm/documentation/
Redis https://redis.io/documentation
PostgreSQL https://www.postgresql.org/docs/9.6/static/index.html
MongoDB https://docs.mongodb.com/

Java只有JDK6核心API的中文版文档:
http://download.oracle.com/technetwork/java/javase/6/docs/zh/api/index.html



(2)文档聚合
DevDocs http://devdocs.io/ 在线API文档浏览,支持模糊搜索,可离线使用(通过AppCache把离线数据保存在IndexedDB中,但容易被浏览器清除)


(3)离线工具
早期没有专门的离线工具,基本都是把官方HTML版的文档或整理的文档,打包成CHM文件,方便查看。比如,苏沈小雨整理的 CSS2中文手册 就使用的非常广泛,估计现在也有人用。


现在,macOS的Dash是最有名的,收费的,但是作者也很开放,允许其他人开发Dash-like应用直接使用所有的Dash docsets。各个平台就有了不同离线文档工具: Dash(OSX)、 Velocity(Windows)、 Zeal(Linux/Windows)、 LovelyDocs(Android)。

Zeal

Velocity


(4)速查手册 CheatSheet
OverAPI.com 收集了大量对开发人员非常有用的速查手册,页面也很简洁。

猜你喜欢

转载自rensanning.iteye.com/blog/2358430