Skip to content

Update STYLE.md #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: blog-functional
Choose a base branch
from
Open

Update STYLE.md #574

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 |