Frames

Untitled

0
1
2
3
1# Topic Page Style Guide
2
3From the GitHub Style Guide:
4
5> Words are an important part of how software works. Just as we have a style guide for our code, we have a style guide for our tone and our voice. Even though there may be dozens of people creating a product, it should still sound like we speak in one consistent voice.
6>
7>**The way we write is just as important as the way we build. Consider these things when writing copy.**
8
9## Principles
10
11* **Make it approachable.** Use familiar language and don't assume the reader has prior topic knowledge.
12* **Keep it concise.** Use the simplest possible language and link to outside content for deeper dives.
13* **Think about the community.** Add content that will benefit many vs. an individual.
14
15## Grammar and usage
16
17### Ampersands
18Use "and" rather than an ampersand unless you’re referencing a brand name, for example: Procter & Gamble.
19
20### Commas
21Always use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma). 
22
23### Dates
24Include and spell out the month. Include the day number without the "th" or "nd" at the end, for example: October 12.
25
26### Exclamation points
27Avoid exclamation points in topic pages and collections.
28
29### GitHub
30Always use correct capitalization when referring to “GitHub” or “Git.” Never use “GitHub” or “Git” as a verb.
31
32### Numbers
33Write out “one” and every number less than 10.
34
35### Users
36Avoid using "users" in favor of developers, people, or a more specific description of the group of people.
37
38### Words that can be tricky
39- **Agile (e.g. agile development):** Don’t capitalize “agile” unless it’s starting a sentence.
40- **Email:** Use “email”, not "e-mail."
41- **Internet:** Don’t capitalize “internet” unless it’s starting a sentence.
42- **Open source:**
43 - Adjective: “Open source” is always lowercase, except when at the start of the sentence. You can use it as an adjective without a hyphen, as in “open source project” or “open source software.”
44 - Noun: You can also use the term on its own to refer to open source in general, as in “give back to open source."
45 - Verb: It’s acceptable to use open source as a verb when referring to a project that has been “open sourced” or that you intend to “open source.”
46- **Pull request:** Never abbreviate "pull request." "Pull request" is always lowercase unless it's starting a sentence.
47- **Repository:** Never abbreviate "repository." "Repository" is always lowercase unless it's starting a sentence.
48