|
| 1 | +# Blog writing style guide |
| 2 | + |
| 3 | +Blog posts on the Pro Git site are written in the same voice as the book. |
| 4 | +This guide describes that voice, derived from the book's own text, so that posts read |
| 5 | +like they were written by the book's authors — because stylistically, they are. |
| 6 | + |
| 7 | +**Anyone (human or agent) writing or editing a post in `src/content/blog/` must read |
| 8 | +this guide first and follow it.** |
| 9 | + |
| 10 | +Every trait below is illustrated with a real sentence from the book. |
| 11 | + |
| 12 | +## Voice and person |
| 13 | + |
| 14 | +**Address the reader as "you"; the authors are "we".** |
| 15 | +The book talks directly to one reader and speaks as its authors, never in an |
| 16 | +impersonal third person. |
| 17 | + |
| 18 | +> You're about to spend several hours of your life reading about Git. |
| 19 | +> Let's take a minute to explain what we have in store for you. |
| 20 | +> — *Introduction* |
| 21 | +
|
| 22 | +**Use "Let's" to start a walkthrough or a worked example.** |
| 23 | + |
| 24 | +> To visualize this, let's assume that you have a directory containing three files, |
| 25 | +> and you stage them all and commit. |
| 26 | +> — *Branches in a Nutshell* |
| 27 | +
|
| 28 | +**Use contractions.** |
| 29 | +"You'll", "it's", "don't", "can't", "we're". The book is conversational, not formal. |
| 30 | + |
| 31 | +## Openers |
| 32 | + |
| 33 | +**Get to the point in the first sentence.** |
| 34 | +Posts open with the fact, then explain. No throat-clearing, no scene-setting. |
| 35 | + |
| 36 | +> So, what is Git in a nutshell? |
| 37 | +> — *What is Git?* |
| 38 | +
|
| 39 | +**Rhetorical questions are welcome — but answer them immediately.** |
| 40 | + |
| 41 | +> What happens when you create a new branch? |
| 42 | +> Well, doing so creates a new pointer for you to move around. |
| 43 | +> — *Creating a New Branch* |
| 44 | +
|
| 45 | +## Tone |
| 46 | + |
| 47 | +**Plain, concrete, and direct.** Explain *why* before *how*. |
| 48 | + |
| 49 | +> This is an important section to absorb, because if you understand what Git is and |
| 50 | +> the fundamentals of how it works, then using Git effectively will probably be much |
| 51 | +> easier for you. |
| 52 | +> — *What is Git?* |
| 53 | +
|
| 54 | +**No hype and no marketing language.** |
| 55 | +Never "excited to announce", "seamless", "robust", "leverage", "delve", "game-changing". |
| 56 | +When the book praises something, it says specifically what is good about it. |
| 57 | + |
| 58 | +**Dry, understated humor — sparingly.** At most one flourish per post, and only when |
| 59 | +it lands naturally. |
| 60 | + |
| 61 | +> If the book spontaneously combusts at this point, you should already be pretty |
| 62 | +> useful wielding Git in the time it takes you to go pick up another copy. |
| 63 | +> — *Introduction* |
| 64 | +
|
| 65 | +**Tell the reader when something matters.** |
| 66 | + |
| 67 | +> Pay attention now — here is the main thing to remember about Git if you want the |
| 68 | +> rest of your learning process to go smoothly. |
| 69 | +> — *The Three States* |
| 70 | +
|
| 71 | +## Structure |
| 72 | + |
| 73 | +**Short paragraphs, one point each.** One to four sentences is typical. |
| 74 | + |
| 75 | +**Signpost what's coming, and end with a bridge.** |
| 76 | +The book constantly tells you where you are going next and closes sections by pointing |
| 77 | +forward. Posts should end the same way: where to follow along, what happens next, or |
| 78 | +where to pitch in. |
| 79 | + |
| 80 | +> Let's get started. |
| 81 | +> — *Introduction* |
| 82 | +
|
| 83 | +**Lists are for enumerable facts; numbered lists are for step sequences.** |
| 84 | +The book uses bullets for parallel facts (the three states) and numbers for workflows |
| 85 | +(the basic Git workflow). Everything else is prose. |
| 86 | + |
| 87 | +## Sentences and punctuation |
| 88 | + |
| 89 | +**Mostly short and medium declarative sentences.** Vary the rhythm; don't stack three |
| 90 | +long sentences in a row. |
| 91 | + |
| 92 | +**Em dashes for asides**, surrounded by spaces (the book's ` -- ` renders as an |
| 93 | +em dash; in MDX write ` — ` directly). |
| 94 | + |
| 95 | +> Most operations in Git need only local files and resources to operate — generally |
| 96 | +> no information is needed from another computer on your network. |
| 97 | +> — *Nearly Every Operation Is Local* |
| 98 | +
|
| 99 | +**Parentheses for quick side remarks.** |
| 100 | + |
| 101 | +> …you can commit happily (to your _local_ copy, remember?) until you get to a |
| 102 | +> network connection to upload. |
| 103 | +> — *Nearly Every Operation Is Local* |
| 104 | +
|
| 105 | +**No exclamation points. No emoji.** |
| 106 | + |
| 107 | +## Formatting conventions |
| 108 | + |
| 109 | +- `monospace` for commands, branch names, file names, config keys: `git branch`, |
| 110 | + `main`, `AGENTS.md`. |
| 111 | +- _Italics_ for a new term at first use, the way the book introduces _snapshots_ |
| 112 | + and _blobs_. Also for book titles: _Pro Git_. |
| 113 | +- **Bold** sparingly, for the one key phrase in a paragraph — the book bolds |
| 114 | + *stream of snapshots*, not whole sentences. |
| 115 | +- Headings only when a post is long enough to need them; short posts are just prose. |
| 116 | + |
| 117 | +## Source formatting |
| 118 | + |
| 119 | +**One sentence per line.** |
| 120 | +The book's AsciiDoc sources put each sentence on its own line (semantic line breaks), |
| 121 | +which keeps diffs reviewable. Do the same in post MDX; Markdown joins the lines when |
| 122 | +rendering. |
| 123 | + |
| 124 | +## Frontmatter |
| 125 | + |
| 126 | +- `description` is one plain sentence, in the same voice. |
| 127 | +- Agent-written posts must set `automated: true` (see `README.md`); this renders the |
| 128 | + "written by AI" banner and is non-negotiable. |
0 commit comments