From e8f0590f37e34b895697f2e95f7e7f8ee92d77e0 Mon Sep 17 00:00:00 2001 From: Liupeng Date: Wed, 1 Sep 2021 08:05:13 +0000 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=96=87=E4=BB=B6=20document?= =?UTF-8?q?ation/tested=20tested.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentation/tested tested.md | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 documentation/tested tested.md diff --git a/documentation/tested tested.md b/documentation/tested tested.md deleted file mode 100644 index c2d125c..0000000 --- a/documentation/tested tested.md +++ /dev/null @@ -1,25 +0,0 @@ -# What Effective Documentation Matters for Open Source Software - -Providing an effective documentation system for open source software builds a strong, inclusive community and increases the usage of your software. - -Open source software provides a unique way to create effective documentation. Users are considered contributors and have access to the source code and documentation. They are encouraged to submit additions, fix code, report errors, and update documentation. Having more contributors can speed up the development of software and documentation. - -A good way to accelerate the usage of your software is to describe its advantages and demonstrate how to use it. There are many benefits of complete and accurate content. **Effective documentation can:** - -- Help to create an inclusive open source community -- Build a user-oriented software product -- Promote the usage of your software -- Reduce users' learning cost -- Reduce TCO -- Improve user interaction - -On the opposite, **ineffective documentation may cause the following problems: ** - -- Time waste -- Software errors or even breakdowns -- User churn -- Increased software support costs -- Shorter life span of your software - -So you need to build an effective documentation system for your open source software. - -- Gitee