@equal-experts/kuat-vue 0.13.1 → 0.14.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/agent-docs/AGENTS.md +1 -1
- package/agent-docs/README.md +1 -1
- package/agent-docs/bundle-manifest.json +12 -20
- package/agent-docs/components/components.manifest.json +3 -0
- package/agent-docs/external/kuat-agent-rules/reference/accessibility/README.md +7 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/accessibility}/accessibility.md +12 -10
- package/agent-docs/external/kuat-agent-rules/reference/brand/README.md +9 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/brand.md +21 -11
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/logo.md +5 -4
- package/agent-docs/external/kuat-agent-rules/reference/brand/voice-and-tone.md +166 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/README.md +12 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/formatting.md +120 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/numbers.md +87 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/punctuation.md +94 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference}/content/writing-style.md +7 -2
- package/agent-docs/external/kuat-agent-rules/reference/design-language/README.md +11 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/borders.md +3 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/colours.md +38 -10
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/design-language.md +11 -10
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/spacing.md +4 -3
- package/agent-docs/external/kuat-agent-rules/reference/design-language/tokens/README.md +29 -0
- package/agent-docs/external/kuat-agent-rules/reference/design-language/tokens/colors.tokens.json +84 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/typography.md +5 -4
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/README.md +10 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/README.md +2 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/blog-posts.md +1 -5
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/marketing-content.md +2 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/seo.md +2 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/emails.md +3 -9
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/patterns/README.md +7 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing/scenarios → reference/media-types/web-marketing/patterns}/marketing-pages.md +3 -3
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/website.md +7 -22
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/README.md +16 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/accessibility.md +2 -12
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/component-decision-tree.md +3 -18
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/component-registry.md +3 -22
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/README.md +2 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/actions.md +1 -7
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/confirmations.md +0 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/empty-states.md +0 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/errors.md +0 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/forms.md +1 -7
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/product-content.md +1 -11
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/design.md +6 -36
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/emails.md +3 -9
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/patterns/README.md +10 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/authentication.md +3 -3
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/dashboards.md +2 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/documentation.md +3 -3
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/forms.md +3 -3
- package/agent-docs/kuat-docs/rules/README.md +37 -30
- package/agent-docs/kuat-docs/rules/design/layouts.md +1 -1
- package/agent-docs/kuat-docs/rules/scenarios/README.md +1 -1
- package/agent-docs/manifest.json +3 -3
- package/agent-docs/rules/LOADING-consumer.md +5 -5
- package/package.json +1 -1
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/LOADING.md +0 -166
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/README.md +0 -28
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/formatting.md +0 -93
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/numbers.md +0 -69
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/punctuation.md +0 -75
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/voice-and-tone.md +0 -263
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/design/README.md +0 -28
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/marketing/scenarios/README.md +0 -18
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/DEPRECATIONS.md +0 -28
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/README.md +0 -65
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/review-checklist.md +0 -57
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/review-context.md +0 -44
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/scenarios/README.md +0 -82
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/technical.md +0 -488
package/agent-docs/AGENTS.md
CHANGED
|
@@ -7,4 +7,4 @@ Rules for this install live under `agent-docs/` in `@equal-experts/kuat-core`, `
|
|
|
7
7
|
3. Load component guides via `agent-docs/components.manifest.json`.
|
|
8
8
|
4. Skills: `kuat-review`, `kuat-create` from [kuat-agent-docs](https://github.com/equalexperts/kuat-agent-docs).
|
|
9
9
|
|
|
10
|
-
**Version:** 0.
|
|
10
|
+
**Version:** 0.14.0-beta.0 · **Rules snapshot:** 538afc80d437
|
package/agent-docs/README.md
CHANGED
|
@@ -18,36 +18,28 @@
|
|
|
18
18
|
"target": "components"
|
|
19
19
|
},
|
|
20
20
|
{
|
|
21
|
-
"source": "external/kuat-agent-rules/
|
|
22
|
-
"target": "external/kuat-agent-rules/
|
|
21
|
+
"source": "external/kuat-agent-rules/reference/brand",
|
|
22
|
+
"target": "external/kuat-agent-rules/reference/brand"
|
|
23
23
|
},
|
|
24
24
|
{
|
|
25
|
-
"source": "external/kuat-agent-rules/
|
|
26
|
-
"target": "external/kuat-agent-rules/
|
|
25
|
+
"source": "external/kuat-agent-rules/reference/accessibility",
|
|
26
|
+
"target": "external/kuat-agent-rules/reference/accessibility"
|
|
27
27
|
},
|
|
28
28
|
{
|
|
29
|
-
"source": "external/kuat-agent-rules/
|
|
30
|
-
"target": "external/kuat-agent-rules/
|
|
29
|
+
"source": "external/kuat-agent-rules/reference/design-language",
|
|
30
|
+
"target": "external/kuat-agent-rules/reference/design-language"
|
|
31
31
|
},
|
|
32
32
|
{
|
|
33
|
-
"source": "external/kuat-agent-rules/
|
|
34
|
-
"target": "external/kuat-agent-rules/
|
|
33
|
+
"source": "external/kuat-agent-rules/reference/content",
|
|
34
|
+
"target": "external/kuat-agent-rules/reference/content"
|
|
35
35
|
},
|
|
36
36
|
{
|
|
37
|
-
"source": "external/kuat-agent-rules/
|
|
38
|
-
"target": "external/kuat-agent-rules/
|
|
37
|
+
"source": "external/kuat-agent-rules/reference/media-types/web-product",
|
|
38
|
+
"target": "external/kuat-agent-rules/reference/media-types/web-product"
|
|
39
39
|
},
|
|
40
40
|
{
|
|
41
|
-
"source": "external/kuat-agent-rules/
|
|
42
|
-
"target": "external/kuat-agent-rules/
|
|
43
|
-
},
|
|
44
|
-
{
|
|
45
|
-
"source": "external/kuat-agent-rules/kuat-docs/rules/types/web/product",
|
|
46
|
-
"target": "external/kuat-agent-rules/kuat-docs/rules/types/web/product"
|
|
47
|
-
},
|
|
48
|
-
{
|
|
49
|
-
"source": "external/kuat-agent-rules/kuat-docs/rules/types/web/marketing",
|
|
50
|
-
"target": "external/kuat-agent-rules/kuat-docs/rules/types/web/marketing"
|
|
41
|
+
"source": "external/kuat-agent-rules/reference/media-types/web-marketing",
|
|
42
|
+
"target": "external/kuat-agent-rules/reference/media-types/web-marketing"
|
|
51
43
|
}
|
|
52
44
|
],
|
|
53
45
|
"denyPathSegments": [
|
|
@@ -3,16 +3,19 @@
|
|
|
3
3
|
"components": {
|
|
4
4
|
"shadcn:button": {
|
|
5
5
|
"slug": "button",
|
|
6
|
+
"displayName": "Button",
|
|
6
7
|
"path": "components/button.md",
|
|
7
8
|
"sources": ["shadcn:button", "@equal-experts/kuat-core"]
|
|
8
9
|
},
|
|
9
10
|
"kuat:button-group": {
|
|
10
11
|
"slug": "button-group",
|
|
12
|
+
"displayName": "ButtonGroup",
|
|
11
13
|
"path": "components/button-group.md",
|
|
12
14
|
"sources": ["@equal-experts/kuat-react", "@equal-experts/kuat-vue"]
|
|
13
15
|
},
|
|
14
16
|
"kuat:kuat-header": {
|
|
15
17
|
"slug": "kuat-header",
|
|
18
|
+
"displayName": "KuatHeader",
|
|
16
19
|
"path": "components/kuat-header.md",
|
|
17
20
|
"sources": ["@equal-experts/kuat-react", "@equal-experts/kuat-vue"]
|
|
18
21
|
}
|
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: general
|
|
3
|
-
---
|
|
4
|
-
|
|
5
1
|
# Accessibility
|
|
6
2
|
|
|
7
3
|
Foundational accessibility requirements for Equal Experts content and products. These rules ensure products and services deliver the best experience for all users.
|
|
@@ -371,11 +367,17 @@ Always spell out abbreviations on first use:
|
|
|
371
367
|
|
|
372
368
|
## Inclusive Language
|
|
373
369
|
|
|
370
|
+
Inclusive language is part of how Equal Experts writes — it helps us be accurate and build trust. Around 16% of people worldwide experience some form of disability, so it matters that we don't unintentionally exclude anyone from accessing or understanding our work. This section is the authoritative source for inclusive word choices across all content; the [writing style](../content/writing-style.md) guidance links here.
|
|
371
|
+
|
|
374
372
|
### Guidelines
|
|
375
373
|
|
|
376
374
|
- Use language that is respectful and free of bias
|
|
377
|
-
- Avoid
|
|
378
|
-
-
|
|
375
|
+
- Avoid terms that contribute to stigmas around disability or mental illness
|
|
376
|
+
- Make content **gender-neutral** wherever possible, and avoid words and phrases that indicate gender bias
|
|
377
|
+
- Avoid words, images, or situations that reinforce racial, ethnic, or religious stereotypes
|
|
378
|
+
- Be considerate with computer and software terminology such as "master", "slave", and "blacklist" — prefer neutral alternatives (for example "main", "primary/replica", "blocklist")
|
|
379
|
+
- Avoid assumptions: when including someone in a piece of content, ask how they'd like to be identified
|
|
380
|
+
- Avoid idioms where possible, or make sure they're clearly explained — they don't always translate across cultures or for non-native readers
|
|
379
381
|
- When in doubt, research current preferred terminology
|
|
380
382
|
|
|
381
383
|
### Person-First Language
|
|
@@ -438,7 +440,7 @@ Always spell out abbreviations on first use:
|
|
|
438
440
|
|
|
439
441
|
## Related Documentation
|
|
440
442
|
|
|
441
|
-
- [Colours](
|
|
442
|
-
- [Typography](
|
|
443
|
-
- [
|
|
444
|
-
- [Web Technical Accessibility](../types/web
|
|
443
|
+
- [Colours](../design-language/colours.md) - Brand colour palette and contrast
|
|
444
|
+
- [Typography](../design-language/typography.md) - Font families and type scale
|
|
445
|
+
- [Writing style](../content/writing-style.md) - Writing style and tone
|
|
446
|
+
- [Web Technical Accessibility](../media-types/web-product/accessibility.md) - Implementation details
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brand
|
|
2
|
+
|
|
3
|
+
Equal Experts brand identity: who EE is and how the brand expresses itself.
|
|
4
|
+
|
|
5
|
+
| File | Scope |
|
|
6
|
+
|------|-------|
|
|
7
|
+
| [brand.md](./brand.md) | Brand principles and identity |
|
|
8
|
+
| [logo.md](./logo.md) | Logo variants, sizing, placement, clear space |
|
|
9
|
+
| [voice-and-tone.md](./voice-and-tone.md) | Voice, tone, audience, content quality |
|
|
@@ -18,21 +18,31 @@ Equal Experts is a network of experienced software consultants, helping organisa
|
|
|
18
18
|
|
|
19
19
|
## Brand Values
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
The Equal Experts values act as principles of how we work with our customers. They are intended to give all members of the network autonomy in making decisions that are aligned with the way we want to behave, as well as how we want to be recognised.
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
### 1. We deliver as teams of equals
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Teams are greater than the sum of their parts. No matter what role people play in a team, they all have something to contribute, and they all have a voice in delivery decisions.
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
### 2. We prioritise outcomes over approach
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
We work in complex and highly dynamic environments. We’re not interested in a cookie-cutter approach.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
### 3. We narrow our focus but widen our context
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
We deliver concrete value as early as possible by quickly identifying key opportunities, but framing them within the wider organisational context.
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
### 4. We bring step-by-step change
|
|
36
|
+
|
|
37
|
+
It can be tempting to look for a WOW factor, but we know that lasting change is best achieved through small, incremental practices that build towards larger transformation.
|
|
38
|
+
|
|
39
|
+
### 5. We have a passion for learning over knowing all the answers
|
|
40
|
+
|
|
41
|
+
We may be experts, but we don’t pretend to know all the answers.
|
|
42
|
+
|
|
43
|
+
### 6. We seek customer success over our own short-term interests
|
|
44
|
+
|
|
45
|
+
We thrive by our reputation, so the only way to guarantee our future success is to do what’s right, right now, for our customers.
|
|
36
46
|
|
|
37
47
|
---
|
|
38
48
|
|
|
@@ -94,6 +104,6 @@ When representing Equal Experts:
|
|
|
94
104
|
## Related Documentation
|
|
95
105
|
|
|
96
106
|
- [Logo Usage](./logo.md) - Logo variants, sizing, placement
|
|
97
|
-
- [Colours](
|
|
98
|
-
- [Typography](
|
|
99
|
-
- [
|
|
107
|
+
- [Colours](../design-language/colours.md) - Brand color palette
|
|
108
|
+
- [Typography](../design-language/typography.md) - Brand fonts
|
|
109
|
+
- [Reference index](../README.md) - All brand reference guides
|
package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/logo.md
RENAMED
|
@@ -121,9 +121,10 @@ The brand mark (without wordmark) should only be used when:
|
|
|
121
121
|
|
|
122
122
|
For platform-specific logo placement guidance:
|
|
123
123
|
|
|
124
|
-
- **Web
|
|
125
|
-
- **
|
|
126
|
-
- **
|
|
124
|
+
- **Web product** - See [media-types/web-product/](../media-types/web-product/)
|
|
125
|
+
- **Web marketing** - See [media-types/web-marketing/](../media-types/web-marketing/)
|
|
126
|
+
- **Slides** - See [media-types/slides/](../media-types/slides/)
|
|
127
|
+
- **Graphics** - See [media-types/imagery/patterns/graphics/](../media-types/imagery/patterns/graphics/)
|
|
127
128
|
|
|
128
129
|
---
|
|
129
130
|
|
|
@@ -148,4 +149,4 @@ All logos are available in the [Equal Experts brand-assets repository](https://g
|
|
|
148
149
|
## Related Documentation
|
|
149
150
|
|
|
150
151
|
- [Brand Guidelines](./brand.md) - Brand principles
|
|
151
|
-
- [Colours](
|
|
152
|
+
- [Colours](../design-language/colours.md) - Brand color palette
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Voice and Tone
|
|
2
|
+
|
|
3
|
+
Universal voice and tone for Equal Experts content. Applies to all platforms and media.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
It's not just *what* we say but *how* we say it that matters. A consistent voice — aligned with our vision, mission, and values — helps us speak to our audience clearly, reflects our culture, and differentiates us from the competition. If the voice isn't reflective of Equal Experts, our work, and our values, we risk key messages being misunderstood or overlooked.
|
|
10
|
+
|
|
11
|
+
Our **voice** is constant: it's who we are. Our **tone** flexes to suit the audience, channel, and purpose.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Quick Reference
|
|
16
|
+
|
|
17
|
+
**Always:**
|
|
18
|
+
- Be friendly, clear, and approachable — one human to another
|
|
19
|
+
- Be confident, but never arrogant; back claims with evidence
|
|
20
|
+
- Focus on the audience and their needs
|
|
21
|
+
- Use plain language; be specific, not vague
|
|
22
|
+
- Be consistent across channels and materials
|
|
23
|
+
|
|
24
|
+
**Never:**
|
|
25
|
+
- Make bold claims without backing them up
|
|
26
|
+
- Hide behind jargon, acronyms, or buzzwords
|
|
27
|
+
- Talk down to, over-simplify for, or patronise the audience
|
|
28
|
+
- Overuse "we" so the content reads as boastful
|
|
29
|
+
- Mix and match tones and styles within a piece
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## How We Describe Equal Experts
|
|
34
|
+
|
|
35
|
+
Equal Experts is a global network of technology shapers. We work collaboratively with clients on digital initiatives that deliver long-lasting change and pragmatic innovation. Engaging around 3,000 consultants across five continents, we help solve complex business problems and create leading digital products and services. We decide with data, design for users, deliver at pace, and scale sustainably.
|
|
36
|
+
|
|
37
|
+
What makes us unique: we engage only senior consultants (averaging around 18 years' experience), we're low-ego and curious, we're vendor-agnostic and don't offer cookie-cutter solutions, and our flexible global delivery model means we're not limited by geography.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Writing in the Equal Experts Voice
|
|
42
|
+
|
|
43
|
+
**Friendly, clear, and approachable.** We speak from one human to another. Though we work with cutting-edge technology, we're not robots and neither are our customers. Content is clear, concise, and purposeful, but reflects how we'd speak face-to-face. Gentle humour is welcome when it arises naturally, is appropriate, and will be widely understood.
|
|
44
|
+
|
|
45
|
+
**Confident, but never arrogant.** With a word as powerful as "expert" in our name, we embody it with humility. We show our knowledge through tangible results and a passion for learning. We're confident without being condescending, and knowledgeable without being know-it-alls.
|
|
46
|
+
|
|
47
|
+
**Focused on the audience.** Our voice adapts to different audiences, channels, and platforms. When we talk about technology, we consider the audience and don't cloud the message with terminology, acronyms, or phrases they're unlikely to understand. We're not dumbing down or patronising — we're meeting the audience where they are.
|
|
48
|
+
|
|
49
|
+
**Genuine, and a team of equals.** Our voice instils trust in our work and our people. We speak positively about our customers — past and present — emphasising collaboration, transparency, and honesty. We voice our opinions but stay open to compromise for the good of the client or team. We're considerate and intentional with our words, paying close attention to inclusivity and accessibility.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Adapting Tone for the Audience
|
|
54
|
+
|
|
55
|
+
The Equal Experts voice flexes to the audience and content type. Internal audiences allow a more informal, conversational tone with more room for humour; sales materials dial up confident, persuasive language.
|
|
56
|
+
|
|
57
|
+
| Audience / channel | Tone |
|
|
58
|
+
|--------------------|------|
|
|
59
|
+
| Case studies (external) | Straightforward and factual, with a focus on storytelling, client collaboration, and results |
|
|
60
|
+
| Blogs (external & internal) | Purposeful and informative, letting the author's personality shine through; answer the audience's questions |
|
|
61
|
+
| Playbooks & informative content | Clear and informative, with evidence-based insights and examples; a strong expert tone |
|
|
62
|
+
| Pitch decks & sales materials | Confident, authoritative, persuasive; definitive statements about our work and impact, always backed by results |
|
|
63
|
+
| Social media | Conversational, friendly, and informal; often addressed to the audience |
|
|
64
|
+
| Internal Blogin & Slack | Friendly, approachable, reflecting the author's personality. Remember NDAs |
|
|
65
|
+
| Knowledge Portal | Deeper, less-polished opinions and insights, useful for the network but not for external view. Remember NDAs |
|
|
66
|
+
|
|
67
|
+
We don't adapt the tone in a way that compromises our values, and we always read as professional, reliable experts who deliver results.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Content Principles
|
|
72
|
+
|
|
73
|
+
These principles underpin all our content, from planning to maintenance.
|
|
74
|
+
|
|
75
|
+
1. **Always be human.** We're humans talking to humans — simple, authentic, and genuine, with personality and humour where it suits.
|
|
76
|
+
2. **Have a clear purpose.** Set the aim, audience, and the goal it serves before you start. What question does this piece answer?
|
|
77
|
+
3. **Know who your audience is.** Understand their situation, behaviours, attitudes, problems, and goals.
|
|
78
|
+
4. **Be clear and concise.** Plain English, the best chance of being read and understood. Don't use ten words when three will do.
|
|
79
|
+
5. **Collaborate with others.** Draw on people with the right skills at the right point in the process.
|
|
80
|
+
6. **Test, iterate, and learn.** Try new content, improve it on feedback and evidence, and share what you learn across the network.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Top Tips
|
|
85
|
+
|
|
86
|
+
- **Write for all readers.** Some read every word; others skim. Descriptive headers, subheaders, lists, and diagrams help people find what they need
|
|
87
|
+
- **Lead with the key message.** Open with the main or most interesting point, then back it up
|
|
88
|
+
- **Use the active voice.** "We reviewed the code", not "The code was reviewed by Equal Experts"
|
|
89
|
+
- **Be clear, concise, and specific.** Plain English, no slang, no unnecessary jargon or acronyms; don't assume prior knowledge
|
|
90
|
+
- **Write like a human.** Being an expert means removing complexity — be relatable, warm, and friendly
|
|
91
|
+
- **Adapt to the audience.** Suit the situation, the reader, and the subject
|
|
92
|
+
- **Don't "we" all over the content.** Too much "we" reads as boastful; emphasise the client and the collaboration
|
|
93
|
+
- **Be consistent.** Apply the same standards and style throughout; don't mix tones
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## UK English and Local Markets
|
|
98
|
+
|
|
99
|
+
We focus on **UK English** for global content, but respect local markets — Australia, the US, Europe, South Africa, and India — where appropriate, adopting local spelling, grammar, and currency in location-specific content.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Audience Considerations
|
|
104
|
+
|
|
105
|
+
### Technical audiences (developers, engineers)
|
|
106
|
+
|
|
107
|
+
**Tone:** Pragmatic, evidence-based, respectful of expertise. Use specific technical detail, code examples, and trade-offs. Avoid over-simplification, buzzwords, and marketing language.
|
|
108
|
+
|
|
109
|
+
### Business stakeholders (product owners, leaders)
|
|
110
|
+
|
|
111
|
+
**Tone:** Outcome-focused, clear, strategic. Use business metrics, efficiency gains, and impact. Avoid deep technical detail without context and unexplained acronyms.
|
|
112
|
+
|
|
113
|
+
### General audiences
|
|
114
|
+
|
|
115
|
+
**Tone:** Helpful, clear, accessible. Use plain language, clear explanations, and practical examples. Avoid corporate speak and jargon.
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Common Pitfalls
|
|
120
|
+
|
|
121
|
+
### Buzzword bingo
|
|
122
|
+
Trendy terminology without substance.
|
|
123
|
+
|
|
124
|
+
❌ "Leveraging synergistic, AI-enabled solutions"
|
|
125
|
+
✅ "We automated invoice processing using existing APIs"
|
|
126
|
+
|
|
127
|
+
### Unbacked claims
|
|
128
|
+
Bold statements without evidence.
|
|
129
|
+
|
|
130
|
+
❌ "We'll dramatically improve your performance"
|
|
131
|
+
✅ "The health check saved the client £3 million"
|
|
132
|
+
|
|
133
|
+
### Over-explanation
|
|
134
|
+
Explaining what needs no explanation.
|
|
135
|
+
|
|
136
|
+
❌ "Click the button below to continue to the next screen"
|
|
137
|
+
✅ [Continue]
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## Content Quality Checklist
|
|
142
|
+
|
|
143
|
+
- **Clarity:** Can it be understood from a 30-second skim?
|
|
144
|
+
- **Purpose:** Does it answer a specific question or solve a problem?
|
|
145
|
+
- **Consistency:** Does it use consistent terminology and patterns?
|
|
146
|
+
- **Audience:** Is it pitched right for the intended reader?
|
|
147
|
+
- **Accessibility:** Does it work for everyone, including assistive-technology users?
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## Platform-Specific Content
|
|
152
|
+
|
|
153
|
+
For platform-specific content guidance:
|
|
154
|
+
|
|
155
|
+
- **Web Marketing** - See [media-types/web-marketing/](../media-types/web-marketing/)
|
|
156
|
+
- **Web Product** - See [media-types/web-product/](../media-types/web-product/)
|
|
157
|
+
- **Slides** - See [media-types/slides/](../media-types/slides/)
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Related Documentation
|
|
162
|
+
|
|
163
|
+
- [Brand Guidelines](./brand.md) - Brand voice and values
|
|
164
|
+
- [Writing style](../content/writing-style.md) - Active voice, plain language, conventions
|
|
165
|
+
- [Inclusive language](../accessibility/accessibility.md#inclusive-language) - Accessible, bias-free word choices
|
|
166
|
+
- [Design language](../design-language/design-language.md) - Visual design principles
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Content
|
|
2
|
+
|
|
3
|
+
How Equal Experts writes — style and usage conventions that apply across every medium. (Voice and tone lives in [brand/](../brand/voice-and-tone.md).)
|
|
4
|
+
|
|
5
|
+
| File | Scope |
|
|
6
|
+
|------|-------|
|
|
7
|
+
| [writing-style.md](./writing-style.md) | Active voice, plain language, conciseness |
|
|
8
|
+
| [formatting.md](./formatting.md) | Capitalisation, headings, links, lists, acronyms |
|
|
9
|
+
| [numbers.md](./numbers.md) | Dates, times, currency, percentages, units |
|
|
10
|
+
| [punctuation.md](./punctuation.md) | Commas, dashes, apostrophes, quotation marks |
|
|
11
|
+
|
|
12
|
+
Inclusive, bias-free word choices live in [accessibility/](../accessibility/accessibility.md#inclusive-language) and are cross-linked from [writing-style.md](./writing-style.md).
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# Formatting
|
|
2
|
+
|
|
3
|
+
How to use bold, capitalisation, headings, links, lists, and abbreviations in Equal Experts content.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Quick Reference
|
|
8
|
+
|
|
9
|
+
- **Capitalisation:** Sentence case for headings, buttons, and body copy; capitals only for proper nouns and product names
|
|
10
|
+
- **Bold:** Use sparingly, only to draw attention to a key point
|
|
11
|
+
- **Italics:** Use only to denote a quote
|
|
12
|
+
- **Underline:** Use only to indicate a link
|
|
13
|
+
- **Links:** Descriptive link text, not "click here" or raw URLs
|
|
14
|
+
- **Lists:** Use sparingly; punctuate by whether items are full sentences
|
|
15
|
+
- **Acronyms:** Spell out on first use, then use the short form
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Capitalisation
|
|
20
|
+
|
|
21
|
+
### Sentence case
|
|
22
|
+
|
|
23
|
+
Use sentence case for:
|
|
24
|
+
- Headings, subheadings, and content titles (no full stop)
|
|
25
|
+
- Button and link labels
|
|
26
|
+
- List items
|
|
27
|
+
- Body copy
|
|
28
|
+
|
|
29
|
+
**Examples:**
|
|
30
|
+
"Helping ease the path to AI adoption in the enterprise"
|
|
31
|
+
"Save and continue"
|
|
32
|
+
"Contact the team"
|
|
33
|
+
|
|
34
|
+
### Capitals in body copy
|
|
35
|
+
|
|
36
|
+
Within the body of the content, use a capital letter only for a **proper noun** (for example a customer or product name). Don't use title case for general headings or UI labels.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Bold, Italics, and Underline
|
|
41
|
+
|
|
42
|
+
- **Bold:** Use sparingly, only when you want to draw attention to a key point: "Building a culture of innovation? You need **Experts** by your side."
|
|
43
|
+
- *Italics:* Use **only to denote a quote**. Don't use italics for emphasis, titles of works, or technical terms.
|
|
44
|
+
- <u>Underline:</u> Use **only to indicate the presence of a link**. Don't underline for emphasis.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Headings
|
|
49
|
+
|
|
50
|
+
- Use headings and subheadings to break up text and help readers scan or jump to what they need
|
|
51
|
+
- Write them in **sentence case with no full stop**, and keep them concise and informative: "Why autonomous agents could be the best thing to happen to AI"
|
|
52
|
+
- One H1 per page or screen; use a logical hierarchy (H1 → H2 → H3) and don't skip levels
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Links
|
|
57
|
+
|
|
58
|
+
- Provide a link whenever you refer to something on another website or page
|
|
59
|
+
- Link text should tell people where they're going and why they'd want to visit — link the relevant keywords, written as a normal sentence
|
|
60
|
+
- Don't use words that wouldn't make sense without the link, and avoid "click here" or "read this" — they're bad for accessibility
|
|
61
|
+
|
|
62
|
+
| Prefer | Avoid |
|
|
63
|
+
|--------|--------|
|
|
64
|
+
| Find out more on our Design service page | Click here for more |
|
|
65
|
+
| Read the accessibility guidelines | Read this |
|
|
66
|
+
| Contact the team | https://example.com/contact |
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Lists
|
|
71
|
+
|
|
72
|
+
Use bullet points for items in no particular order; use a numbered list when the order matters. Use lists sparingly — too many in one piece dilutes their impact. Introduce a list with text followed by a colon.
|
|
73
|
+
|
|
74
|
+
**Items that are not full sentences:** start each with a lower-case letter, follow each with a comma, end the penultimate item with "and", and end the last item with a full stop:
|
|
75
|
+
|
|
76
|
+
> Equal Experts can help your business in many ways. We can:
|
|
77
|
+
> - solve complex business problems,
|
|
78
|
+
> - upskill your staff and
|
|
79
|
+
> - scale your business for the future.
|
|
80
|
+
|
|
81
|
+
**Items that are full sentences:** punctuate them like sentences, with a capital letter and a full stop:
|
|
82
|
+
|
|
83
|
+
> Inceptions are based on principles and paradigms that we know make the difference:
|
|
84
|
+
> - We validate that our solution is desirable, viable and feasible.
|
|
85
|
+
> - We deliver the most valuable outcomes when we focus on the problem and the outcome.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Buttons
|
|
90
|
+
|
|
91
|
+
- Button text should describe the resulting **action** and be clear and concise
|
|
92
|
+
- **Capitalise only the first word** ("Save and continue", "Contact us")
|
|
93
|
+
- For product UI button patterns, see [web-product actions](../media-types/web-product/content/actions.md)
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Abbreviations and Acronyms
|
|
98
|
+
|
|
99
|
+
- Spell out on first use with the short form in parentheses: "The Planning and Resource Allocation Committee (PRAC) decided to continue." Then use the short form: "We meet with the PRAC every two weeks."
|
|
100
|
+
- This **isn't required for well-known acronyms** (for example NHS, BBC)
|
|
101
|
+
- **Latin abbreviations** (e.g., etc., i.e.) may be used, but must be used correctly, in the right context, and with full stops
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Emojis and Hashtags
|
|
106
|
+
|
|
107
|
+
Use emojis and hashtags thoughtfully, mainly in social media posts.
|
|
108
|
+
|
|
109
|
+
- Don't add too many emojis; they should complement the text, not replace it. Check the post still makes sense if the emoji is removed
|
|
110
|
+
- Make sure an emoji is appropriate and doesn't carry an alternative meaning online
|
|
111
|
+
- Use **camel case** for hashtags so they're readable for assistive technology: #BlackLivesMatter, not #blacklivesmatter
|
|
112
|
+
- Use 3–5 hashtags on LinkedIn and 1–2 on X; look for relevant event, industry, or topic tags
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Related Documentation
|
|
117
|
+
|
|
118
|
+
- [Voice and tone](../brand/voice-and-tone.md)
|
|
119
|
+
- [Writing style](./writing-style.md)
|
|
120
|
+
- [Numbers](./numbers.md) - Dates, currency, units
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Numbers
|
|
2
|
+
|
|
3
|
+
Guidance for numbers, dates, times, and currency in Equal Experts content.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Quick Reference
|
|
8
|
+
|
|
9
|
+
- **Words vs figures:** Spell out one to ten; use figures for 11 and above
|
|
10
|
+
- **Always figures:** Percentages, measurements, and currency always use figures and symbols (10%, 1.61m, £4m)
|
|
11
|
+
- **Dates:** Day before month, no "th"/"st", never "the" (13 April, not the 13th of April)
|
|
12
|
+
- **Times:** 12-hour uses a full stop (11.30am); 24-hour uses a colon (13:00). Don't mix the two
|
|
13
|
+
- **Currency:** Default to a generic £ for global content; use local currency for single-country content
|
|
14
|
+
- **Large numbers:** Use commas for thousands (3,000); abbreviate very large round numbers (1k, 2m)
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Words or Figures
|
|
19
|
+
|
|
20
|
+
- Spell out whole numbers from **one to ten**: "We worked with the client for two months."
|
|
21
|
+
- Use **figures for 11 and above**: "Our work involved 35 teams across the organisation."
|
|
22
|
+
- If a number is the **first word of a sentence**, spell it out: "Eleven people worked in the team."
|
|
23
|
+
- If a paragraph has **multiple figures**, use figures throughout so readers can compare easily: "There were 2 people in the team when we started, and 22 when we finished."
|
|
24
|
+
|
|
25
|
+
**Exception:** percentages, measurements, and currency always use figures and symbols, even below 11 (see below).
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Ordinals
|
|
30
|
+
|
|
31
|
+
- Spell out **first to tenth**: "She was the first person to see the problem."
|
|
32
|
+
- Use figures with **st, nd, rd, th** for larger ordinals: "The 19th president of the United States was Rutherford B Hayes."
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Percentages, Measurements, and Currency
|
|
37
|
+
|
|
38
|
+
Always use figures and symbols, regardless of the one-to-ten rule.
|
|
39
|
+
|
|
40
|
+
- **Percentages:** Use the % symbol with the figure (10%, 12.5%). For a range, "40–60%" (en dash, no space)
|
|
41
|
+
- **Measurements:** "The average height of a woman in the UK is 1.61m." Leave a space when spelling out units in prose where it reads naturally
|
|
42
|
+
- **Currency:** See [Money and currency](#money-and-currency) below
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Large Numbers
|
|
47
|
+
|
|
48
|
+
- Use commas as thousand separators: "We reviewed 3,000 lines of code."
|
|
49
|
+
- For very large round numbers, combine a figure with a word or letter, or abbreviate to 1k or 2m: "The population of the earth is now more than 7 billion people." / "The budget came in at just under £2m."
|
|
50
|
+
- Keep formatting consistent across tables and lists.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Money and Currency
|
|
55
|
+
|
|
56
|
+
- The default currency is a **generic £** sign on anything that may be referenced globally
|
|
57
|
+
- If content is intended for a **single country**, adopt the local currency: "Our US-based client has seen efficiencies in the region of $1.3m."
|
|
58
|
+
- Abbreviate large round amounts: "The cost savings for our client were £4m."
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## Dates
|
|
63
|
+
|
|
64
|
+
- Always put the **date before the month** — even in US-focused content, for clarity: "Easter this year is on 13 April." / "Armistice Day is on 11 November."
|
|
65
|
+
- Don't use "th", "st", "nd", or "rd" with dates, and never precede the number with "the"
|
|
66
|
+
- **Shorten periods** of time where it isn't ambiguous: "The First World War (1914–18)."
|
|
67
|
+
- For a **financial year**, use the format "2020–21": "The company did better in 2020–21 than in 2019–20."
|
|
68
|
+
- Use the **day of the week with a date** only for emphasis or to avoid confusion: "The Agile on the Beach conference starts on Friday 13 April."
|
|
69
|
+
- In code, data, and other technical fields where an unambiguous machine format is needed, ISO 8601 (YYYY-MM-DD) is acceptable; it is the exception, not the prose style.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Time
|
|
74
|
+
|
|
75
|
+
- Use either the 12-hour or 24-hour clock — **not both** in the same text
|
|
76
|
+
- **12-hour clock:** Use a full stop between hours and minutes, with am/pm: "The meeting starts at 11.30am and ends at 1pm."
|
|
77
|
+
- **24-hour clock:** Use a colon and omit am/pm: "The meeting starts at 11:30 and ends at 13:00."
|
|
78
|
+
- Use **"noon"** or **"midnight"** instead of "12", "12 noon", or "12 midnight"
|
|
79
|
+
- When you use "from" with a start time or date, pair it with "to" for the end — not a dash: "The third financial quarter runs from October to December."
|
|
80
|
+
- Specify a time zone when the reader needs to act or compare across regions ("2.30pm GMT")
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Related Documentation
|
|
85
|
+
|
|
86
|
+
- [Formatting](./formatting.md) - Capitalisation, lists
|
|
87
|
+
- [Punctuation](./punctuation.md) - En dash for ranges, "from … to"
|