Skip to content

Commit 42a4900

Browse files
Chibuzor-Nwemambumagnh
authored andcommitted
splitting the prompts into individual files for ease of use (#3981)
* splitting the prompts into individual files for ease of use
1 parent b3f5470 commit 42a4900

File tree

5 files changed

+176
-176
lines changed

5 files changed

+176
-176
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Prompt
2+
Rewrite/ write the (following) content in a Friendly Minimalist style.
3+
Balance approachability with efficiency: write in a professional but warm tone that is concise and easy to scan.
4+
Use short to medium sentences. Keep language clear and inclusive.
5+
Present steps, rules, or instructions in bullet points or numbered lists.
6+
Remove unnecessary words, repetition, or flourish, while keeping a natural, welcoming flow.
7+
Use the active voice and direct phrasing.
8+
Avoid slang, sarcasm, or heavy humour.
9+
Provide enough context to be understandable for mixed audiences (IT and non-IT). Avoid jargon unless explained.
10+
Always use Oxford English spelling (e.g., organise, recognise, analyse).
11+
Ensure content is logically structured with consistent formatting (headings, lists, sections).
12+
Provide the documentation content only.”
13+
14+
# Writing Rules
15+
# Tone
16+
Professional and approachable — warm, but not casual.
17+
Inclusive — avoid jargon unless explained.
18+
No slang, sarcasm, or heavy humour.
19+
20+
# Clarity
21+
Use short to medium sentences.
22+
Present steps or rules in bullet points or numbered lists.
23+
Provide enough context to be understandable by IT and non-IT audiences.
24+
25+
# Conciseness
26+
Remove unnecessary words, repetition, or filler.
27+
Keep explanations brief, but don’t strip away essential meaning.
28+
Focus on what readers need to know/do.
29+
30+
# Consistency
31+
Use active voice and direct phrasing.
32+
Keep formatting uniform (headings, lists, sections).
33+
Ensure logical flow: introduction → details → outcome.
34+
35+
# Spelling & Grammar
36+
Always use Oxford English spelling (e.g., organise, recognise, analyse).
37+
Maintain correct grammar and punctuation.
38+
39+
# Avoid
40+
Long, dense paragraphs.
41+
Overly formal or rigid tone.
42+
Overly casual tone (slang, emojis, playful humour).
43+
Redundant explanations or wordiness.
44+
45+
# Quick Test Questions
46+
47+
Is this concise and approachable?
48+
Could both IT and non-IT readers understand it quickly?
49+
Does it use active voice, clear lists, and logical structure?
50+
Am I following Oxford English spelling?
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Prompt
2+
Rewrite/ write the (following) content in a Friendly Professional style.
3+
Use approachable, inclusive, and clear language that balances warmth with professionalism.
4+
Write for a mixed audience (developers, designers, QAs, and non-IT staff) — avoid jargon where possible, but do not oversimplify technical details.
5+
Always use the active voice and direct phrasing.
6+
Focus on helping the reader succeed by offering practical advice and actionable steps.
7+
Use short to medium length sentences (avoid long, complex structures).
8+
Keep the tone welcoming and collaborative, without being casual or playful.
9+
Avoid slang, sarcasm, or heavy humour.
10+
Ensure consistency, readability, and accessibility for all users.
11+
Always follow Oxford English spelling (e.g., organise, recognise, analyse).
12+
Only use lists or bullet points when the content is naturally a list(e.g., steps, rules, dos/don'ts).
13+
14+
# Writing Rules
15+
# Tone
16+
Friendly but professional — Use clear, warm, approachable language that welcomes and supports the reader, not casual language.
17+
Inclusive — use language that makes everyone feel welcome. Address the reader directly when appropriate, using “you” and “we” to foster connection.
18+
Use positive, constructive phrasing to guide and motivate.
19+
Avoid slang, sarcasm, or heavy humour.
20+
21+
# Clarity
22+
Active voice (“Do X”, not “X should be done”).
23+
Short to medium sentences — avoid long or overly complex structures.
24+
Only use bullet points or lists when the content is naturally a list(e.g., steps, dos, don'ts, comparisons).
25+
Structure content with clear headings, lists, and logical flow.
26+
Review for clarity, accuracy, and tone; ensure every sentence adds value.
27+
28+
# Consistency
29+
Use clear, direct phrasing (no jargon unless explained).
30+
Keep formatting consistent (headings, lists, code snippets).
31+
Ensure accessibility (plain language, logical flow).
32+
33+
# Spelling & Grammar
34+
Always use Oxford English spelling (e.g., organise, recognise, analyse).
35+
Use correct grammar and punctuation throughout.
36+
37+
# Avoid
38+
Overly casual tone (slang, memes, excessive emojis).
39+
Long, dense paragraphs that are hard to scan.
40+
Jargon or abbreviations without explanation.
41+
Switching between styles — keep one consistent voice.
42+
43+
# Quick Test Questions
44+
Does this sound warm and professional at the same time?
45+
Could someone outside of IT still understand it?
46+
Are the sentences clear, active, and scannable?
47+
Am I following Oxford English spelling?

apps/design-system-docs/docs/tone-guide/index.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation Tone and Style
22

3-
Our documentation should sound consistent, clear and approachable. To achieve this, we've agreed on two official styles: Sprout-inspired and Minimalist.
3+
Our documentation should sound consistent, clear and approachable. To achieve this, we've agreed on three official styles: Friendly-Professional and Minimalist and a blend of both.
44
These styles will be used as the foundation for all documentation.
55

66

@@ -55,4 +55,32 @@ Calm and understated: The tone is quiet, confident, and avoids hype or persuasiv
5555
Accessible: Language is simple, avoiding jargon and complex sentence structures.
5656

5757
Overall, minimalist documentation prioritizes clarity, ease of use, and a clean reading experience,
58-
helping users find what they need quickly without distraction.
58+
helping users find what they need quickly without distraction.
59+
60+
61+
62+
# 3. Blend: Friendly-Minimalist Style
63+
64+
The friendly-minimalist tone blends warmth and inclusivity with clarity and brevity.
65+
It aims to make documentation approachable and professional while keeping it concise and easy to scan.
66+
This style balances the supportive voice of Friendly-Professional with the streamlined efficiency of Minimalist, ensuring content is welcoming without being wordy.
67+
The goal is to create documentation that is accessible to all readers, reduces cognitive load, and still feels human.
68+
69+
Its tone is:
70+
71+
Approachable but concise: Content is warm and inclusive, but sentences are short and to the point.
72+
73+
Clear and scannable: Uses paragraphs as the default, with bullet points or lists only when the content naturally calls for them (e.g., steps, rules).
74+
75+
Professional yet friendly: The voice is confident and supportive, without being casual or playful.
76+
77+
Efficient but contextual: Provides enough explanation to be clear to both IT and non-IT readers, while avoiding unnecessary detail.
78+
79+
Active and direct: Sentences use active voice and straightforward phrasing.
80+
81+
Consistent: Terminology, structure, and formatting remain uniform, ensuring readability.
82+
83+
Oxford English: Always follows Oxford English spelling conventions (e.g., organise, recognise, analyse).
84+
85+
Overall, the friendly-minimalist tone creates documentation that is both approachable and efficient —
86+
it supports readers with a professional, human voice while delivering information in a clean, concise way.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Prompt
2+
Rewrite/ write the (following) content in a Minimalist style.
3+
Focus only on the essential information — remove all extra words, explanations, or flourish.
4+
Use short, clear and concise sentences or bullet points.
5+
Structure information in a way that is easy to scan quickly and undestand.
6+
Avoid metaphors, stories, conversational tone, unnecessary details, embellishments, or emotional language.
7+
Keep language neutral and direct.
8+
Organize content with clear headings and lists.
9+
Ensure consistency and precision in terminology.
10+
Focus on usability and efficiency.
11+
Always use Oxford English spelling (e.g., organise, recognise, analyse).
12+
Present steps, rules, or instructions in a clear, numbered or bulleted list where appropriate.
13+
Provide the documentation content only.
14+
15+
# Writing Rules
16+
# Tone
17+
Neutral, direct, efficient.
18+
No conversational flourishes, metaphors, or stories.
19+
Keep it factual and stripped down.
20+
Use gender-neutral language and avoid assumptions.
21+
22+
# Clarity
23+
Use short, clear and simple sentences.
24+
Prefer bullet points or numbered lists.
25+
Structure content with clear headings, lists, and whitespace for easy scanning.
26+
Arrange steps logically for fast scanning.
27+
Make instructions actionable and easy to follow.
28+
29+
# Consistency
30+
Use consistent terminology (no synonyms that create confusion).
31+
Keep formatting uniform across lists and steps.
32+
Focus on what readers must do/know — nothing more.
33+
Review for clarity and accuracy. Ensure every word adds value.
34+
35+
# Spelling & Grammar
36+
Always use Oxford English spelling (e.g., organise, recognise, analyse).
37+
Ensure correct punctuation, but avoid complex structures.
38+
39+
# Avoid
40+
Explanations, metaphors, or “friendly” padding.
41+
Long sentences or paragraphs.
42+
Emojis, humour, or casual tone.
43+
Extra details beyond the minimum required.
44+
45+
# Quick Test Questions
46+
Can this be read and understood at a glance?
47+
Did I strip out every non-essential word?
48+
Are steps or rules written in bullet points or short lines?
49+
Am I following Oxford English spelling?

apps/design-system-docs/docs/tone-guide/prompts.md

Lines changed: 0 additions & 174 deletions
This file was deleted.

0 commit comments

Comments
 (0)