维护开源项目一年,最大的体会是:好文档比好代码更重要,一个文档烂的项目,代码再优秀也没人用。分享一下写好文档的心得。
一份合格的开源文档至少要包含:
- README:30 秒说清"这是什么、解决什么问题、怎么开始"
- 快速上手:复制粘贴就能跑起来的最小示例
- 使用指南:覆盖核心功能的进阶用法
- API 参考:准确、可检索、有示例
- 贡献指南:告诉别人怎么参与
最大的坑是文档跟代码不同步,发布前一定要检查。另外,文档要面向新手写,维护者自己太熟反而容易跳过关键步骤。
大家的开源项目文档是怎么组织的?有什么让文档更好维护的实践?