From 1adb011ea0f1cec647349814fbbacf4cb00bc0dd Mon Sep 17 00:00:00 2001 From: Liupeng Date: Sat, 28 Aug 2021 01:04:16 +0000 Subject: [PATCH 1/3] update documentation/voice-and-tone.md. --- documentation/voice-and-tone.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/voice-and-tone.md b/documentation/voice-and-tone.md index dbed3bc..46130ae 100644 --- a/documentation/voice-and-tone.md +++ b/documentation/voice-and-tone.md @@ -16,7 +16,7 @@ For example, **Use simple language**, as many of our readers may not be native English speakers. Therefore, -- Don't idioms. Use more formal terms that are well defined. +- Don't use idioms. Use more formal terms that are well defined. - Keep things brief, and avoid words and phrases that are vague or confusing. -- Gitee From 7aa5257fa46b6c726db009215e023257e2929fa5 Mon Sep 17 00:00:00 2001 From: Liupeng Date: Sat, 28 Aug 2021 02:00:45 +0000 Subject: [PATCH 2/3] what-effective-documentation-matters --- .../what-effective-documentation-matters.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 documentation/what-effective-documentation-matters.md diff --git a/documentation/what-effective-documentation-matters.md b/documentation/what-effective-documentation-matters.md new file mode 100644 index 0000000..c2d125c --- /dev/null +++ b/documentation/what-effective-documentation-matters.md @@ -0,0 +1,25 @@ +# 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 From ad78304b7fad41817d35779c5f695c3970cf8f28 Mon Sep 17 00:00:00 2001 From: Liupeng Date: Sat, 28 Aug 2021 09:39:06 +0000 Subject: [PATCH 3/3] Test.... Updated a file. Additional information: we tested xxx --- documentation/tested tested.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 documentation/tested tested.md diff --git a/documentation/tested tested.md b/documentation/tested tested.md new file mode 100644 index 0000000..c2d125c --- /dev/null +++ b/documentation/tested tested.md @@ -0,0 +1,25 @@ +# 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