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. + +
| Preposition | +UI element | +Recommended | +
|---|---|---|
| in | +
+ dialogs +fields +lists +menus +sidebars +windows + |
+
+ In the Delete User dialog, enter the name and click OK. +In the Name field, enter 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. + |
+