`
rensanning
  • 浏览: 3552651 次
  • 性别: Icon_minigender_1
  • 来自: 大连
博客专栏
Efef1dba-f7dd-3931-8a61-8e1c76c3e39f
使用Titanium Mo...
浏览量:38217
Bbab2146-6e1d-3c50-acd6-c8bae29e307d
Cordova 3.x入门...
浏览量:607606
C08766e7-8a33-3f9b-9155-654af05c3484
常用Java开源Libra...
浏览量:682786
77063fb3-0ee7-3bfa-9c72-2a0234ebf83e
搭建 CentOS 6 服...
浏览量:89534
E40e5e76-1f3b-398e-b6a6-dc9cfbb38156
Spring Boot 入...
浏览量:402151
Abe39461-b089-344f-99fa-cdfbddea0e18
基于Spring Secu...
浏览量:69760
66a41a70-fdf0-3dc9-aa31-19b7e8b24672
MQTT入门
浏览量:91835
社区版块
存档分类
最新评论

关于开发文档

 
阅读更多
(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 收集了大量对开发人员非常有用的速查手册,页面也很简洁。

  • 大小: 38.5 KB
  • 大小: 103.6 KB
  • 大小: 70.1 KB
  • 大小: 36.6 KB
  • 大小: 48 KB
  • 大小: 49.3 KB
  • 大小: 123.7 KB
分享到:
评论

相关推荐

    软件开发文档说明(完整流程)

    以下是关于软件开发文档的详细解释: 首先,软件开发设计文档包括以下几类: 1. 软件需求说明书:这是软件开发的第一步,它详细描述了软件的目标、功能、性能、用户界面和运行环境。通常包含引言(编写目的、背景...

    海康威视开发文档.zip

    海康威视作为全球领先的安防产品及解决方案提供商,其开发文档是开发者和系统集成商进行摄像头集成、视频处理以及监控系统构建的重要参考资料。本压缩包文件"海康威视开发文档.zip"包含了与海康威视摄像头接口相关的...

    软件开发相关文档软件开发文档软件开发文档软件开发文档

    本文将深入探讨软件开发文档的重要性、种类、结构以及如何编写有效的软件开发文档。 首先,软件开发文档是整个开发流程的灵魂,它记录了项目的每一个阶段,包括需求分析、设计、编码、测试和维护等。文档的清晰度和...

    软件开发文档模板(最全)

    本文将深入探讨“软件开发文档模板(最全)”所涵盖的几个核心部分:需求文档、设计文档和开发文档,以及它们如何在软件生命周期中发挥作用。 1. **需求文档**: - 需求分析报告:详细描述软件应实现的功能和非...

    软件开发文档模板

    以下是对"软件开发文档模板"的详细解析: 1. **需求规格说明书**:这份文档详细阐述了软件的需求,包括功能性和非功能性需求。它帮助开发者明确系统的目标,确保所有参与者对项目有统一的理解。内容通常涵盖用户...

    开发文档模板[全套].zip

    《软件开发文档:产品经理与程序员的协作指南》 在软件开发过程中,良好的文档是团队协作、沟通理解的关键。"开发文档模板[全套].zip"提供了一整套完整的开发文档模版,旨在帮助产品经理和程序员更好地理解和执行...

    Arduino中文开发文档

    Arduino开发文档包含了大量关于常见传感器(如温度、湿度、光线、运动等)和执行器(如电机、伺服电机、LED)的信息,包括如何连接、配置和读取数据。每个传感器和执行器都有相应的库支持,方便用户快速集成到项目中...

    软件开发文档模板合集

    "软件开发文档模板合集"提供了一系列的标准模板,帮助开发者规范地完成各个阶段的工作,确保项目的顺利进行。 1. 可行性研究报告:在项目启动阶段,可行性研究报告用于评估项目的可能性,包括技术可行性、经济可行...

    开发文档 软件工程 完整案例 开发文档

    在软件开发过程中,开发文档是不可或缺的一部分,它记录了项目的全过程,从需求分析到系统设计,再到编码实现和测试验证,最后是维护更新。本文将深入探讨“开发文档 软件工程 完整案例 开发文档”这一主题,特别...

    ERP用友开发文档

    ERP用友开发文档 ERP用友开发文档 ERP用友开发文档 ERP用友开发文档

    2019WPS二次开发文档API.zip

    "2019WPS二次开发文档API.zip"这个压缩包文件,正是为了帮助开发者深入了解并利用这些接口而准备的资料集。其中包含了2015年的二次开发文档,虽然时间有些许滞后,但其核心理念和主要API接口依然具有很高的参考价值...

    软件开发文档编写

    在软件开发过程中,编写高质量的开发文档是至关重要的。它不仅有助于团队间的沟通与协作,还可以作为项目管理和维护的依据。下面将详细讲解软件开发文档的编写及其重要性。 一、开发文档概述 开发文档是记录软件...

    软件开发文档范例-概要设计说明书.zip程序开发文档软件开发文技术档下载

    软件开发文档范例-概要设计说明书.zip程序开发文档软件开发文技术档下载软件开发文档范例-概要设计说明书.zip程序开发文档软件开发文技术档下载软件开发文档范例-概要设计说明书.zip程序开发文档软件开发文技术档...

    TRX插件开发文档TRX插件开发文档

    TRX插件开发文档 TRX插件开发文档 TRX插件开发文档 TRX插件开发文档

    fanuc二次开发文档

    【标题】"fanuc二次开发文档"涉及到的核心概念是Fanuc数控系统(FANUC CNC)的二次开发,这是对Fanuc控制系统进行自定义功能扩展的过程。Fanuc是一家全球知名的数控系统制造商,其产品广泛应用于机床行业。通过二次...

    HIKVISION开发文档2.0

    海康威视开发文档2.0是针对其IP监控系统开发的接口规范和应用指南。这份文档详细说明了如何通过IP Surveillance API来实现与海康威视前端和后端设备的交互。通过这份文档,开发者可以学习到如何整合与使用海康威视的...

    东集小码哥PDA开发文档

    【东集小码哥PDA开发文档】是一份详尽的指南,专为开发者提供关于如何在东集小码哥PDA上进行软件开发的知识。这份文档覆盖了从基础概念到高级技术应用的各个方面,旨在帮助开发者充分利用这款设备的功能,进行高效、...

    软件项目开发文档模板-全套

    在软件开发过程中,一套完整的项目开发文档是至关重要的。这些文档不仅规范了开发流程,确保项目的顺利进行,还能提高团队沟通效率,降低出错风险。本资源“软件项目开发文档模板-全套”提供了涵盖开发全周期的一...

    携程api开发文档.rar

    携程API开发文档是针对开发者提供的一份详尽指南,它涵盖了在开发与携程系统集成的应用程序时所需的所有关键信息。这份文档是携程开放平台的重要组成部分,旨在帮助开发者理解如何有效地利用携程的接口和服务,以...

    finereport开发文档

    FineReport开发文档的最后部分讲解了关于单元格HTML内容、单元格值改变、单元格元素扩展、打印时修改单元格值、页面事件、预览执行等细节方面的技术知识。这些内容对于插件的细粒度控制和高级功能实现具有指导意义。...

Global site tag (gtag.js) - Google Analytics