diff --git a/documentation/Voice-and-Tone.md b/documentation/Voice-and-Tone.md new file mode 100644 index 0000000000000000000000000000000000000000..23521af081362112243dcd255223d27c9bdf5378 --- /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 diff --git a/documentation/how-to-write-about.md b/documentation/how-to-write-about.md index bb0f851077e38565bc52abb8e76c5ea8e48d7231..1b47d065b87fd947075b854a59b73b39fc231edc 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 @@ -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