From 76547a35317eb4b5037d46e7cd1f3418a66e1ad6 Mon Sep 17 00:00:00 2001 From: Gurnoor-coding Date: Wed, 18 Jun 2025 20:50:14 -0700 Subject: [PATCH] Update STYLE.md Keploy API Fellowship, I am a person who is new, so I decided to just test the pull request feature. I have done so by adding to the README, I have added a purpose statement, and some more hopefully helpful information. Signed-off-by: Gurnoor-coding --- STYLE.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/STYLE.md b/STYLE.md index 01852911e..95206dfbb 100644 --- a/STYLE.md +++ b/STYLE.md @@ -3,6 +3,11 @@ In general, Keploy content follows the [Google developer documentation style guide](https://developers.google.com/style). 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/). +## Purpose + +This document defines the style conventions used in Keploy documentation to ensure clarity, consistency, and professionalism across all content. +It is intended for contributors, technical writers, and engineers writing or editing Keploy docs. + ## Keploy-specific style guidance 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 - Correct: "How to get started with Keploy" - Incorrect: "How To Get Started With Keploy" + +### Example + +- Incorrect “Keploy installation instructions” — not infinitive, not compelling + +- Incorrect “How To Install Keploy” — wrong casing + +- Correct “Install Keploy” — clear, action-oriented, SEO-friendly + +### Tone + +Write in a friendly, professional tone. +Use active voice whenever possible. +Avoid slang, idioms, or overly technical jargon unless necessary. +Assume the reader is intelligent but unfamiliar with the product. + +### Quick reference + +| Rule Category | Keploy Style Recommendation | +| ------------------- | ------------------------------------------------------------------------ | +| Capitalization | Capitalize Keploy-specific terms when referring to them in documentation | +| Headings | Use sentence case and infinitive verbs in titles and section headings | +| Ranges | Use en dashes (`–`) or words like “to” and “through” consistently | +| Voice | Prefer active voice over passive voice | +| Tone | Write in a friendly, professional, and clear tone | +| Consistency | Apply formatting choices consistently throughout a document | +| Reference Order | Follow the Google style guide; defer to Microsoft when Google is silent | + +