Develop Writing Style Guidelines for Rancher Desktop

[rak-phillip]

Rancher Desktop has grown significantly and, with a diverse group of contributors, maintaining a consistent writing style is becoming increasingly important. Inconsistencies in tone, terminology, and formatting can impact the quality and usability of Rancher Desktop.

Establishing writing style guidelines could:

• Improve the clarity and intent of features throughout Rancher Desktop
• Ensure a consistent and professional presentation of information
• Help contributors align their writing with the project's goals and values

Proposed Solution

1. Research and identify reference style guides that align with the Rancher Desktop's needs. If necessary, we may create a custom style guide

2. The guidelines will cover aspects such as grammar, formatting, tone, terminology, and how to handle project-specific jargon

3. Explore and possibly implement tools like Vale ¹ to help enforce and maintain the guidelines

Footnotes

1. https://vale.sh/ ↩