From 562a11cdda51636aff4058c8f464978ceeb29725 Mon Sep 17 00:00:00 2001 From: Liupeng Date: Thu, 9 Sep 2021 11:47:30 +0000 Subject: [PATCH 1/2] update documentation/what-effective-documentation-matters.md. --- documentation/what-effective-documentation-matters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/what-effective-documentation-matters.md b/documentation/what-effective-documentation-matters.md index c2d125c..fd87e48 100644 --- a/documentation/what-effective-documentation-matters.md +++ b/documentation/what-effective-documentation-matters.md @@ -13,7 +13,7 @@ A good way to accelerate the usage of your software is to describe its advantage - Reduce TCO - Improve user interaction -On the opposite, **ineffective documentation may cause the following problems: ** +On the opposite, **ineffective documentation may cause the following problems:** - Time waste - Software errors or even breakdowns -- Gitee From 9403043d6e763566e91d922ec358a137695dba4a Mon Sep 17 00:00:00 2001 From: Liupeng Date: Thu, 9 Sep 2021 11:51:39 +0000 Subject: [PATCH 2/2] Added a file about UX writing for open source projects Added a file about UX writing for open source projects --- .../3-key-principles-of-UX-writing.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 documentation/3-key-principles-of-UX-writing.md diff --git a/documentation/3-key-principles-of-UX-writing.md b/documentation/3-key-principles-of-UX-writing.md new file mode 100644 index 0000000..0d3236c --- /dev/null +++ b/documentation/3-key-principles-of-UX-writing.md @@ -0,0 +1,42 @@ +# The 3 Key Principles of UX Writing in Open Source Projects + +User experience (UX) writing is the art of crafting the texts that appear throughout the interface of digital products (websites, mobile apps, etc.). It matters when we write for our open source projects. + +Benefits of well written UX writing include: + +* Improved development experience + +* More people involved in your project + +* Reduced support costs + +![Writing](https://media-exp1.licdn.com/dms/image/C561BAQGUBZMzrQkQxg/company-background_10000/0/1538239835301?e=2159024400&v=beta&t=ItPeaCK0T_ke178DIrEgK5LEWQapFOh3PmK4ExKWszk "Writing") + + + +## Key Principle 1: Clear + +Keep it simple, stupid (KISS). Users understand what you talk about, the core message isn't blurred or complicated. That means: + +* Be Specific + +* Concise + +* Avoid Jargon + +## Key Principle 2: Consistent + +Consistency breeds familiarity and familiarity promotes stickiness. + +If we can cultivate a consistent experience across the repositories of our open source project, including word usage and a similar tone for similar contexts, users will feel at ease with all the repositories. + +## Key Principle 3: Helpful + +For example, when we writing a README for our project, we need to answer at least the three questions: + +* What was your motivation? +* Why did you build this project? +* What problem does it solve? + +**For our open source project, consider our audience's likely background, goals, and current mood. A good UX writing will have more people use and contribute to our project.** + -- Gitee