-
Notifications
You must be signed in to change notification settings - Fork 0
/
company_terminology.yml
43 lines (37 loc) · 2.02 KB
/
company_terminology.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
description: Guidelines about company-specific terminology.
content:
- section: Branding
sectionrules:
- rule: |
### Product names<br>
Don't shorten Aperture Science's product names in public-facing documentation.<br>
examples:
- |
**No:** You must activate the button to proceed.
- |
**Yes:** You must activate the 1500 Megawatt Aperture Science Heavy Duty Super-Colliding Super Button to proceed.
audience: [tw, dev, mktg]
featured: |
[Don't shorten Aperture Science's product names.]({{site.baseurl}}{{page.permalink}}company-terminology/#product-names)
- rule: |
### Internal vs. external names<br>
Unless you're referring to a specific function or piece of code that includes an internal codename, always use external names in public-facing documentation.
examples:
- |
Instead of HostileBot, say **Aperture Science Sentry Turret**.
- |
Instead of LoveSquare, say **Aperture Science Weighted Companion Cube**.
audience: [tw, dev]
featured: |
[Don't use internal product codenames in public-facing documentation.]({{site.baseurl}}{{page.permalink}}company-terminology/#internal-vs-external-names)
- section: Other terminology
sectionrules:
- rule: |
### Failure isn't always bad<br>
Science relies on failure as much as it relies on success. Rather than berating a test subject for falling into a pit of toxic sludge, thank them for expanding the number of data points available about the effects of prolonged sludge exposure.
audience: [tw, dev, mktg]
- rule: |
### Words to avoid<br>
* Don't refer to test subjects as *guinea pigs* or *lab rats*. Instead, reassure all test subjects that they are active participants in the scientific process and possess far greater cognitive faculties than most rodents ever could.
* Don't use words like *experiment* or *clinical trial*; instead, say *test* or *Aperture Science Highly-Regulated Data Collection Session*.
audience: [tw, dev, mktg]