01-About Documentation

s

About Documentation

  我们认为文档对于用户很重要，但是不同的用户对文档的要求也不一样。所以，在nodejs.org上，你会看到三种类型的文档：

1、reference documentation

2、getting started documentation

3、tutorials

  API reference documentation主要是提供方法或pattern详细的版本信息，通过这个文档你可以明确方法的参数列表和返回值，以及相关的错误信息（异常？或是返回值的error code？不清楚，暂且这样认为吧）。并且通过这个文档你也可以识别不同版本的node.js该使用过哪个方法。（可能最新的方法在老的版本中不支持，或者有些方法在新的版本中已经废弃）

  Getting Started materials 是为了让你轻松入门、理解Node中的一些概念。通常是一些简单的代码片断，以帮助你理解Node中设计模式，同样在社区中的其它模块中你也会看到类似的模式。

  Tutorials是稍高级点的主题、文档，旨在指导用户详细的使用Node的用例。其主要强调Node的不同使用方法，但不讨论它与社区中第三方模块的异同。

    所有的文档只涉及Node内建的模块，Node对争谁更牛逼没兴趣，我们只客观地讨论我们的API。

s

s