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 0000000000000000000000000000000000000000..0d3236c733e6562172011a4c7a7e370f54cbd42c --- /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.** + diff --git a/documentation/what-effective-documentation-matters.md b/documentation/what-effective-documentation-matters.md index c2d125ceeee205370668bafb00286593c67ad0c8..fd87e481687f8149d4858820a658631dc532a71b 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