-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |