From 5abefdbaaa787ca414d7ab0bf6a2b033bfb5473c Mon Sep 17 00:00:00 2001 From: Liupeng Date: Thu, 26 Aug 2021 14:50:50 +0000 Subject: [PATCH 1/5] update documentation/how-to-write-about.md. --- documentation/how-to-write-about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/how-to-write-about.md b/documentation/how-to-write-about.md index bb0f851..b417429 100644 --- a/documentation/how-to-write-about.md +++ b/documentation/how-to-write-about.md @@ -1,4 +1,4 @@ -### How to write the "About" description of a project +# How to write the "About" description of a project "About" (简介) provides a brief introduction to the project. A good "About" is -- Gitee From ade1eb5c6356566c3bbe8f07f680f65f8719899e Mon Sep 17 00:00:00 2001 From: Liupeng Date: Thu, 26 Aug 2021 15:04:29 +0000 Subject: [PATCH 2/5] update documentation/how-to-write-about.md. --- documentation/how-to-write-about.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/how-to-write-about.md b/documentation/how-to-write-about.md index b417429..1b47d06 100644 --- a/documentation/how-to-write-about.md +++ b/documentation/how-to-write-about.md @@ -29,8 +29,8 @@ For example, - A bundle which aims to provide a full integration of MeilliSearch in Symfony -"About" can be a short, full sentence or a noun phrase. Choose the right style -based on the project characteristics. +"About" can be a short, full sentence or a noun phrase. Choose the right style +based on the project characteristics. -When we choose to use a noun phrase, start it with an article when needed but do -not use a period (.) at the end. \ No newline at end of file +When we choose to use a noun phrase, start it with an article when needed but do +not use a period (.) at the end. \ No newline at end of file -- Gitee From ee6c58fc1525749b7e1f1b2ade15ef4e14fc277a Mon Sep 17 00:00:00 2001 From: Liupeng Date: Thu, 26 Aug 2021 15:06:08 +0000 Subject: [PATCH 3/5] update documentation/how-to-write-about.md. --- documentation/how-to-write-about.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/how-to-write-about.md b/documentation/how-to-write-about.md index 1b47d06..08ae9de 100644 --- a/documentation/how-to-write-about.md +++ b/documentation/how-to-write-about.md @@ -29,8 +29,8 @@ For example, - A bundle which aims to provide a full integration of MeilliSearch in Symfony -"About" can be a short, full sentence or a noun phrase. Choose the right style +"About" can be a short, full sentence or a noun phrase. Choose the right style based on the project characteristics. -When we choose to use a noun phrase, start it with an article when needed but do +When we choose to use a noun phrase, start it with an article when needed but do not use a period (.) at the end. \ No newline at end of file -- Gitee From 9287a12e9fc8ec0b20bc184cb7ab692e3f9bb6b4 Mon Sep 17 00:00:00 2001 From: Liupeng Date: Thu, 26 Aug 2021 15:06:39 +0000 Subject: [PATCH 4/5] update documentation/how-to-write-about.md. --- documentation/how-to-write-about.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/how-to-write-about.md b/documentation/how-to-write-about.md index 08ae9de..1b47d06 100644 --- a/documentation/how-to-write-about.md +++ b/documentation/how-to-write-about.md @@ -29,8 +29,8 @@ For example, - A bundle which aims to provide a full integration of MeilliSearch in Symfony -"About" can be a short, full sentence or a noun phrase. Choose the right style +"About" can be a short, full sentence or a noun phrase. Choose the right style based on the project characteristics. -When we choose to use a noun phrase, start it with an article when needed but do +When we choose to use a noun phrase, start it with an article when needed but do not use a period (.) at the end. \ No newline at end of file -- Gitee From f7484346c5a9d63ce24c0023220018110ad193a0 Mon Sep 17 00:00:00 2001 From: Liupeng Date: Fri, 27 Aug 2021 01:43:54 +0000 Subject: [PATCH 5/5] Added the Voice & Tone of openEuler documentation --- documentation/Voice-and-Tone.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 documentation/Voice-and-Tone.md diff --git a/documentation/Voice-and-Tone.md b/documentation/Voice-and-Tone.md new file mode 100644 index 0000000..23521af --- /dev/null +++ b/documentation/Voice-and-Tone.md @@ -0,0 +1,27 @@ +# Voice and Tone of openEuler Documentation + +The openEuler developer community is built more than just code. Our voice and tone set developers' expectation for the efficient and valuable experiences, resources, and interactions that openEuler provides. + +## Conversational tone + +==Using a lighthearted, friendly tone== and offering specific suggestions for contributions can go a long way in making people feel welcomed and excited to participate in openEuler. + +For example, + +"Hi Judith, welcome to the openEuler Community. I'm the Bot here serving you." + +"First off, thank you for considering contributing to openEuler. It’s people like you that make openEuler such a great community." + +## Inclusive language + +==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. + +- Keep things brief, and avoid words and phrases that are vague or confusing. + +==All users and developers are welcomed== in the openEuler community. We're going to have people with diverse backgrounds. Therefore, + +- Don't use any terms that any group may feel offended. +- Always use gender-neutral pronouns. +- Don't assume people have prior knowledge about openEuler. Provide the basic knowledge needed to better understand openEuler. \ No newline at end of file -- Gitee