我觉得无论是英文还是中文文档,最重要的是清晰和简洁。
pocoo[0] 的文档就是一个很好的例子。
另外有些文档大而全,但是看起来不着边际,入门很难;但是当你认真去斟酌其字字句句之后会醍醐灌顶,大有收获。
sqlalchemy[1] 就是这类的典型代表。
不知道各位认为怎样去写、翻译文档才是最好的呢?
[0] http://flask.pocoo.org/
[1] http://www.sqlalchemy.org/docs/
pocoo[0] 的文档就是一个很好的例子。
另外有些文档大而全,但是看起来不着边际,入门很难;但是当你认真去斟酌其字字句句之后会醍醐灌顶,大有收获。
sqlalchemy[1] 就是这类的典型代表。
不知道各位认为怎样去写、翻译文档才是最好的呢?
[0] http://flask.pocoo.org/
[1] http://www.sqlalchemy.org/docs/