This section provides guidelines for localizing documentation into different languages.
General Guidelines
- Consistency: Ensure that the terminology and style are consistent throughout the documentation.
- Accuracy: Make sure the content is accurate and reflects the product or service correctly.
- Readability: The documentation should be easy to read and understand for the target audience.
Language-Specific Guidelines
English
- Tone: Use a formal tone that is professional and clear.
- Formatting: Follow the standard formatting conventions for English documentation.
中文
- 语调: 使用正式、专业的语调，确保内容清晰易懂。
- 格式: 遵循中文文档的标准格式规范。
Image Usage
When including images, make sure they are relevant to the content and provide additional value. For example, if you are discussing a new feature, include a screenshot of the feature in action.
Example
Here is an example of how to include an image in the documentation:
Step 1: Identify the image you want to include. For instance, a screenshot of a new feature.
Step 2: Create a link to the image using the following format:
Replace <关键词> with the appropriate keyword for the image. For example, if the image is a screenshot of a new feature, the keyword could be "new_feature".
Step 3: Insert the image into the documentation using the following format:
This will display the image with the description "Image description" next to it.
For more information on creating and using images in documentation, please refer to the Image Guidelines.
Note: When including images, make sure they are royalty-free or you have the appropriate permissions to use them.