本项目是一个开源技术项目的文档指南,希望能对开源技术项目的文档部分进行最基本的一些规范定义,从而对项目的文档完善起到一些参考作用。 本指南定义开源技术项目中哪些文档是必须的,以及这些文档应该有哪些内容章节,并需要达到什么的质量要求,便于开发者了解、使用和贡献这个开源项目。

1. 开源项目的负责人可以参考此文档,检查自己的开源技术项目是否已有这些文档,这些文档是否达到本指南的各个质量要求
2. 开源项目的文档负责人可以参考此文档,把这些文档作为自己项目的文档模版,按需增补自己项目的特定内容,从而快速达到文档完备的基本要求
3. 本指南作为开放原子基金会TOC的工作文档一部分,作为导师帮助孵化项目达到文档质量要求的参考和Checklist
4. 作为国内开源项目技术传播工程师社区(包括布道,文档等)的一个初始产出

1. Readme-相关 (鹏飞负责)

2. 快速上手指南-相关(Yu 负责)

3. Contributing-相关 (Jennifer负责)

4. COC(行为规范)-相关(谭中意负责)

1. 第一部分阐述本文档的目的和作用,以及应该有哪些章节和每个章节应该达到的质量要求
2. 第二部分给出一个live的例子,即用在真实的知名项目中,质量还不错的例子
3. 第三部分是一个Checklist,针对第一部分的要求给出的多个Check Items,可以供工程师或者导师进行文档的检查

这是「快速上手指南」的写作规范,仅供参考

本项目欢迎贡献

本项目遵守如下的行为规范

二维码如下,欢迎大家扫码加入,和我们一起讨论开源项目技术传播的事情,包括技术文档协作,技术线上和线下布道等等。