Please refer to this style guide when you contribute to Klaytn Docs.
- Write clearly and accurately.
- Be aware of your audience.
- Get to the point.
- Be consistent.
- Be friendly.
- Include everyone.
Use clear language, while maintaining technical accuracy. Replace technical jargons with simpler words.
Always consider Klaytn users' needs and help them complete processes quickly and easily. Do this by including all steps in procedures, suggesting best practices, and including tips and other types of notes.
Provide relevant content without being wordy. Avoid repeating details in a single topic.
Use the same terminology, formatting, voice, and tone.
All people are welcome here. Use appropriate language as it relates to matters of identity.
For more information, see the Microsoft bias-free writing guidelines.
Generally, we abide by the Microsoft Writing Style Guide because it shares our goal of creating clear and useful content. However, we don't follow every rule, and, in some cases, we break the rules in favor of our own.
Here are some of the more important guidelines we use. If you follow at least these guidelines, your content will begin to resemble other parts of the documentation, making a consistent experience for Terra users.
Use the spelled-out term followed by the acronym in parentheses, such as Governance Council (GC). Use only the acronym for subsequent occurrences in the same topic.
Use sentence-style capitalization in all levels of headings.
Use the present tense and active voice.
- KLAY is always capitalized. There is no plural form. (2 KLAY)
- Klaytn is written in sentence case.