|
3 | 3 | In general, Keploy content follows the [Google developer documentation style guide](https://developers.google.com/style). |
4 | 4 | When the Google guide is silent about an issue, we follow the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/). |
5 | 5 |
|
| 6 | +## Purpose |
| 7 | + |
| 8 | +This document defines the style conventions used in Keploy documentation to ensure clarity, consistency, and professionalism across all content. |
| 9 | +It is intended for contributors, technical writers, and engineers writing or editing Keploy docs. |
| 10 | + |
6 | 11 | ## Keploy-specific style guidance |
7 | 12 |
|
8 | 13 | We have a few Keploy-specific style guidelines that override the Google and Microsoft guides. |
@@ -48,3 +53,32 @@ Sentence casing means that only the first letter of the first word and proper no |
48 | 53 |
|
49 | 54 | - Correct: "How to get started with Keploy" |
50 | 55 | - Incorrect: "How To Get Started With Keploy" |
| 56 | + |
| 57 | +### Example |
| 58 | + |
| 59 | +- Incorrect “Keploy installation instructions” — not infinitive, not compelling |
| 60 | + |
| 61 | +- Incorrect “How To Install Keploy” — wrong casing |
| 62 | + |
| 63 | +- Correct “Install Keploy” — clear, action-oriented, SEO-friendly |
| 64 | + |
| 65 | +### Tone |
| 66 | + |
| 67 | +Write in a friendly, professional tone. |
| 68 | +Use active voice whenever possible. |
| 69 | +Avoid slang, idioms, or overly technical jargon unless necessary. |
| 70 | +Assume the reader is intelligent but unfamiliar with the product. |
| 71 | + |
| 72 | +### Quick reference |
| 73 | + |
| 74 | +| Rule Category | Keploy Style Recommendation | |
| 75 | +| ------------------- | ------------------------------------------------------------------------ | |
| 76 | +| Capitalization | Capitalize Keploy-specific terms when referring to them in documentation | |
| 77 | +| Headings | Use sentence case and infinitive verbs in titles and section headings | |
| 78 | +| Ranges | Use en dashes (`–`) or words like “to” and “through” consistently | |
| 79 | +| Voice | Prefer active voice over passive voice | |
| 80 | +| Tone | Write in a friendly, professional, and clear tone | |
| 81 | +| Consistency | Apply formatting choices consistently throughout a document | |
| 82 | +| Reference Order | Follow the Google style guide; defer to Microsoft when Google is silent | |
| 83 | + |
| 84 | + |
0 commit comments