Back to home

Motivating developers to write API documentation

Source: http://www.youtube.com/watch?v=o99GhqUIbDA

  • 给出API文档标准
  • 文化:不好的文档记为Bug
  • 不接受没有简要文档的补丁
  • 建立 pre-commit 检查
    • 可用性
    • 可访问
    • 文档
    • 函数(至少有一行描述)
    • 参数
    • 返回值
    • 问题(Issue)摘要
    • 修改注意
    • 测试
    • 性能
  • 实践
    • 项目源码包含所有文档(通过一个标准代码补丁)
    • 文档页面留置一个“报Bug”链接
    • “新手”问题标签
    • 导师训练步骤中
    • 专注于文档复审和确认