大家认为怎样的文档才是一个好的文档？

[hbc]

我觉得无论是英文还是中文文档，最重要的是清晰和简洁。

pocoo[0] 的文档就是一个很好的例子。

另外有些文档大而全，但是看起来不着边际，入门很难；但是当你认真去斟酌其字字句句之后会醍醐灌顶，大有收获。

sqlalchemy[1] 就是这类的典型代表。

不知道各位认为怎样去写、翻译文档才是最好的呢？

[0] http://flask.pocoo.org/
[1] http://www.sqlalchemy.org/docs/

[Livid]

iOS SDK 的文档也很不错。

* 组织得很有条理
* 有适当的配图
* 没有废话

http://developer.apple.com/library/ios/navigation/

[hbc]

@Livid 没有废话这点异常赞同，在看 Dive into HTML5 将近全书完毕的时候，最终还是忍受不住作者那种罗嗦的口吻，而放弃继续阅读剩下的几个章节了。

[flyingkid]

google的帮助中心。

m$

mozilla