From c96e7935c9f0975d353e05e2413122a722b90b62 Mon Sep 17 00:00:00 2001 From: itas109 Date: Sun, 13 Dec 2020 01:15:41 +0800 Subject: [PATCH] =?UTF-8?q?update=20=E7=AC=AC4=E9=83=A8=E5=88=86=E2=80=94?= =?UTF-8?q?=E2=80=94=E5=90=AF=E5=8A=A8=E8=87=AA=E5=B7=B1=E7=9A=84=E5=BC=80?= =?UTF-8?q?=E6=BA=90=E9=A1=B9=E7=9B=AE/=E4=B8=BA=E5=BC=80=E6=BA=90?= =?UTF-8?q?=E9=A1=B9=E7=9B=AE=E5=BB=BA=E7=AB=8B=E8=89=AF=E5=A5=BD=E7=9A=84?= =?UTF-8?q?=E5=9F=BA=E7=A1=80.md.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...\275\347\232\204\345\237\272\347\241\200.md" | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git "a/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" "b/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" index 4bdb076..1ddfb0a 100644 --- "a/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" +++ "b/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" @@ -49,9 +49,20 @@ README 应该包含哪些内容： 参考成熟的开源项目的README中的内容以及同类型开源项目中的README。 ### 为项目撰写文档 -``` -补充相关内容 -``` + +项目文档是开源项目非常重要的一个部分，很多开发者会根据项目文档来决定是否使用或学习该项目，并且非常关注是项目文档的入门部分。 + +项目文档应该包含哪些内容： + +- 项目简介：项目名称、背景、特点等。 +- 快速入门：安装、入门示例、典型示例、常见问题解答等。 +- 基础指南：各模块使用说明、旧版本迁移指南等。 +- 进阶指南：架构设计说明、高级用法等。 +- 技术博客：知识普及、使用技巧、性能对比、应用案例等。 +- 技术支持：线上社区（如微信群、QQ群、钉钉群、微博、公众号等）、线下交流会、培训、视频、推荐书籍及博客等。 +- 版本发布计划：制定版本发布时间表，规划项目的未来发展方向等。 +- 国际化：面向全球开发者的项目需要支持多国语言的项目文档。 + ### 开源项目的代码质量要求 -- Gitee