You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,12 +25,12 @@ The following is a summary of the most important elements of our style guide, pl
25
25
- Word Choice, Tone, and Voice:
26
26
- Use active voice
27
27
- 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"
29
29
- Use present tense (for example, use "returns" and not "will return")
30
30
- Write in a friendly tone without using slang, jargon, or frivolous words
31
31
- Avoid marketing language that is overly promotional
32
32
- 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
34
34
- Try to use fewer than 26 words per sentence
35
35
- 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.
36
36
@@ -72,7 +72,7 @@ When generating content for Replicated Docs with LLMs, add the following to the
72
72
- Don't repeat the same information mutiple times. Focus on being concise and using as few words as possible to get the point across
73
73
- Use paragraphs instead of bulleted lists unless specifically asked
74
74
- Don't number the items in unordered lists. Numbered lists are reserved for step-by-step procedures
0 commit comments