From c7df07f9ea603eaf54780b6682e8bdc5e51ba620 Mon Sep 17 00:00:00 2001 From: Sherlock113 Date: Wed, 2 Jun 2021 13:50:55 +0800 Subject: [PATCH] Update Doc style guide Signed-off-by: Sherlock113 --- KubeSphere Documentation Style Guide.md | 53 +++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 3 deletions(-) diff --git a/KubeSphere Documentation Style Guide.md b/KubeSphere Documentation Style Guide.md index 49735d5f9..b3e6cab8b 100644 --- a/KubeSphere Documentation Style Guide.md +++ b/KubeSphere Documentation Style Guide.md @@ -2,7 +2,7 @@ This style guide provides a set of editorial guidelines for those who are writing documentation for KubeSphere. -## **Basic Rules** +## Basic Rules - Write clearly, concisely and precisely. - English is the preferred language to use when you write documentation. If you are not sure whether you are writing correctly, you can use grammar checkers (for example, [grammarly](https://www.grammarly.com/)). Although they are not 100% accurate, they can help you get rid of most of the wording issues. That said, Chinese is also acceptable if you really don't know how to express your meaning in English. @@ -69,7 +69,7 @@ Use a **period** or a **conjunction** between two **complete** sentences. | Check the status of the component. You can see it is running normally. | Check the status of the component, you can see it is running normally. | | Check the status of the component, and you can see it is running normally. | Check the status of the component, you can see it is running normally. | -### **Bold** +### Bold - Mark any UI text (for example, a button) in bold. @@ -84,7 +84,54 @@ Use a **period** or a **conjunction** between two **complete** sentences. KubeSphere is a **distributed operating system managing cloud-native applications** with Kubernetes as its kernel. -### **Code** +### Prepositions + +When describing the UI, you can use the following prepositions. + + + + + + + + + + + + + + + + + + + + + +
PrepositionUI elementRecommended
in +

dialogs

+

fields

+

lists

+

menus

+

sidebars

+

windows

+ 		+

In the Delete User dialog, enter the name and click OK.

+

In the Name field, enter demo-name.

+

In the Language drop-down list, select a desired language.

+

In the More menu, click Delete.

+

Click Volumes under Storage in the sidebar.

+

In the Metering and Billing window, click View Consumption.

+
on +

pages

+

tabs

+ 		+

On the Volumes page, click Create.

+

On the Deployments tab, click Create.

+
+ + +### Code - For short commands, you can just put them within ``. This is often used when you only need to tell readers about a short command or it is sufficient to express your meaning just with the command in a sentence.