Git Product home page Git Product logo

doc_guide's Introduction

doc_guide

What's this

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

使用场景

  1. 开源项目的负责人可以参考此文档,看看自己项目是否已经有这些文档,文档是否达到本指南的各个要求
  2. 本指南拟作为开放原子基金会TOC的工作文档,作为导师帮助项目达到文档质量要求的参考和checklist
  3. 作为国内开源项目文档工程师社区的一个初始产出

贡献者

名字 github id 所属公司或组织
谭中意 tanzhongyi003 开放原子基金会
周鹏飞
刘昱
jennifer

文档列表

  1. Readme相关 (鹏飞负责)

  2. Quick start相关 (刘昱负责)

  3. Contributing相关 (jennifer负责)

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

本项目文档的规范

每个文档分为三个部分

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

Code of Conduct

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

doc_guide's People

Contributors

tanzhongyi003 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.