From 4216a42c9f5a88f9362f583e7c1c61515b8db590 Mon Sep 17 00:00:00 2001 From: Hank Chow <280630620@qq.com> Date: Wed, 18 Mar 2020 10:03:11 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85=E4=B8=80=E8=A1=8C=E9=81=97?= =?UTF-8?q?=E6=BC=8F=E7=9A=84=E7=BF=BB=E8=AF=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...rite effective documentation for your open source project.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/translated/tech/20200312 How to write effective documentation for your open source project.md b/translated/tech/20200312 How to write effective documentation for your open source project.md index 0a48079106..51cd81bacd 100644 --- a/translated/tech/20200312 How to write effective documentation for your open source project.md +++ b/translated/tech/20200312 How to write effective documentation for your open source project.md @@ -52,7 +52,7 @@ 上面提到的三步过程是一个很有用的框架，对一篇文档“入门”部分的设计和量化评估很有帮助。今后你如果想将你的[开源项目产品化][7]，这个框架还可能对实现价值的时间time-to-value产生影响。 -### Other core components +### 其它核心部分 认真写好“入门”部分之后，你的文档中还需要有这五个部分：架构设计、生产环境使用指导、使用案例、参考资料以及未来展望，这五个部分在一份完整的文档中是必不可少的。