Skip to content

Commit a6267de

Browse files
committed
edits to style guide
1 parent c851af4 commit a6267de

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ The following is a summary of the most important elements of our style guide, pl
2525
- Word Choice, Tone, and Voice:
2626
- Use active voice
2727
- Use the second person "you" to address the reader. Never use "let's" or "we" to refer to an action that the user is doing
28-
- Instead of "we", use "Replicated" to talk about recommendations/suggestions. As in "Replicated recommends that you test your releases..."
28+
- Use "Replicated" instead of "we" to talk about recommendations/suggestions. As in "Replicated recommends that you test your releases..." and not "we recommend"
2929
- Use present tense (for example, use "returns" and not "will return")
3030
- Write in a friendly tone without using slang, jargon, or frivolous words
3131
- Avoid marketing language that is overly promotional
3232
- Avoid terms like "simple" or "easy"
33-
- Use common words. Don't use words like "utilize" or "leverage" when you mean "use". This make the docs more suitable for a global audience
33+
- Use common words. Don't use words like "utilize" or "leverage" when you mean "use". Using common words makes the docs more suitable for a global audience
3434
- Try to use fewer than 26 words per sentence
3535
- Avoid time-bound terminology like "currently", "new", "at this time", and "now". Instead, write timeless documentation that makes no assumptions about a reader's prior knowledge.
3636

@@ -72,7 +72,7 @@ When generating content for Replicated Docs with LLMs, add the following to the
7272
- Don't repeat the same information mutiple times. Focus on being concise and using as few words as possible to get the point across
7373
- Use paragraphs instead of bulleted lists unless specifically asked
7474
- Don't number the items in unordered lists. Numbered lists are reserved for step-by-step procedures
75-
-
75+
- Limit the use of notes and asides
7676
```
7777

7878
### Use the @doc-reviewer Claude Subagent

0 commit comments

Comments
 (0)