Skip to content

Commit

Permalink
Add style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Dec 26, 2023
1 parent b25ae88 commit 300a3ce
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions doc/style-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Style guide

## Blog posts

### Voice

* Direct; writing should be succinct and to the point
* Personal and informal is OK up to a point
* For example, avoid opening a blog post with "Knock knock. Who's there? It's me,
Matt, and ..."
* Talking about my passions, hobbies, sense of humor, learning style, etc. is fine.
Using some limited slang is probably fine, but consider inclusiveness (English may
not be every readers' first language, and slang dialect is an unnecessary layer of
obfuscation).
* Use emoji liberally in headings; very conservatively in prose.
* Emojis at the beginning of the heading, not at the end.
* If positioning an emoji in the middle of the heading, there should be a really
good reason.


### Structure

* Short sections broken up in to little subsections, each with headings/subheadings.
* Short paragraphs.


#### General format

* Recap/TLDR: Summarize everything! Spoil the solution.
* Introduction: Sets up a problem.
* Body: Describes a solution in detail.
* Conclusion: Wrap-up, why you should do this.

0 comments on commit 300a3ce

Please sign in to comment.