本项目是一个开源技术项目的文档指南,希望能对开源技术项目的文档部分进行最基本的一些规范,从而对项目的文档完善起到一些参考作用, 定义开源技术项目里哪些文档是必须的,以及这些文档应该有哪些内容章节,各需要达到什么的质量要求,便于开发者了解、使用和贡献这个开源项目。
- 开源项目的负责人可以参考此文档,看看自己项目是否已经有这些文档,文档是否达到本指南的各个要求
- 本指南拟作为开放原子基金会TOC的工作文档,作为导师帮助项目达到文档质量要求的参考和checklist
- 作为国内开源项目文档工程师社区的一个初始产出
名字 | github id | 所属公司或组织 |
---|---|---|
谭中意 | tanzhongyi003 | 开放原子基金会 |
周鹏飞 | ||
刘昱 | ||
jennifer |
-
Readme相关 (鹏飞负责)
-
Quick start相关 (刘昱负责)
-
Contributing相关 (jennifer负责)
- 第一部分阐述本文档的目的和作用,以及应该有哪些章节,每个章节应该达到的质量要求
- 第二部分给出一个live的例子,即用在真实的知名项目中,觉得还不错的例子
- 第三部分是一个Checklist,针对第一部分的要求给出的多个Check Items,可以供工程师进行文档的检查