In general, Keploy content follows the Google developer documentation style guide. When the Google guide is silent about an issue, we follow the Microsoft Writing Style Guide.
We have a few Keploy-specific style guidelines that override the Google and Microsoft guides.
Many of Keploy's core terms can be used in a generic way. To differentiate one of Keploy's core terms from a generic instance of a term, always treat the Keploy term as a proper noun in documentation. Generic versions of the same term should not be capitalized and should be used sparingly to avoid confusion.
- Correct: "Next, Normalise the Test case on the Test run details."
- Incorrect: "Next, normalise the test case on the test run details"
Using an en dash (– or the character –) in a range of numbers is acceptable.
Even better is to use words such as from, to, and through.
Be consistent. If you use an en dash in one range, use en dashes in all ranges. Do not mix words and en dashes (or hyphens, for that matter).
- Correct: "5 to 10 GB"
- Correct: "5–10 GB"
- Correct: "5-10 GB"
- Incorrect: "from 5-10 GB"
Although the following guidance is provided by both the Google and Microsoft guides, we want to emphasize how we style headings.
Titles and headings should use infinitive verb forms whenever possible. People tend to search by using infinitive verb forms, so using them helps SEO.
- Correct: "Install Keploy"
- Incorrect: "Installing Keploy"
Use sentence casing for titles and headings. Sentence casing means that only the first letter of the first word and proper nouns are capitalized.
- Correct: "How to get started with Keploy"
- Incorrect: "How To Get Started With Keploy"