blogging-guidelines/presentation.html at master · praqma-thi/blogging-guidelines · GitHub

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<!DOCTYPE html>
<html>

<head>
    <title>Blogging guidelines</title>
    <meta charset="utf-8">
    <style>
        @import url(https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz);
        @import url(https://fonts.googleapis.com/css?family=Karma:400,700,400italic);
        @import url(https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700,400italic);

        body {
            font-family: 'Karma';
        }

        h1,
        h2,
        h3 {
            font-family: 'Yanone Kaffeesatz';
            font-weight: normal;
        }

        .remark-code,
        .remark-inline-code {
            font-family: 'Ubuntu Mono';
        }

        .img-i img {
            width: 7.5%;
        }

        .img-m img {
            width: 50%;
        }
    </style>
</head>

<body>
    <textarea id="source">

class: center, middle

.img-m[![praqma logo](img/praqma-logo.png)]
# Blogging guidelines

---

# Contents

 1. Ground rules
 2. Fairy dust
 3. Tech blog checklist

---

# Ground rules

Before you even start writing, decide on your:

 * subject
 * target audience
 * goal
 * tone


This will help you write a consistent and enjoyable post.

---

## Ground rules - Subject .img-i[![microscope](img/microscope.png)]

### What are you writing about?

What toolstack, problem, solution, methodology, etc. is the text about?

_Tips:_

* List some key points you want to make beforehand
* Link to external resources instead of going on tangents

---

## Ground rules - Target audiance .img-i[![audience](img/audience.png)]

### Who are you writing for?

Are they technical experts, fresh rookies or oblivious managers?

_Tips:_

 * Write a small bio of your hypothetical reader
 * Look for assumptions of pre-existing knowledge in your post

---

## Ground rules - Goal .img-i[![goal](img/goal.png)]

### What do you want to achieve?

Do you want to inspire, spark discussion, or document a deviously clever hack?

_Tips:_

 * Make suggestions
 * Link to more resources
 * Ask open questions
 * Provide copy-paste examples

---

 ## Ground rules - Tone .img-i[![tone](img/tone.png)]

 ### How do you want to come across?

Are you narrating an idyllic scene, critically analyzing a toolstack, or humorously retelling a story from the trenches?

 _Tips:_
  * Try out different tones of writing
  * Avoid negative comments when writing a feel-good post
  * Insert your personal thoughts and opinions

---

# Fairy dust

To spice up your language and make it a more enjoyable read, add:

 * a dash of Aristotle
 * a pinch of Sinek
 * a sprinkling of Orwell
 * a bucket of your wonderful self

---

## Fairy dust - Aristotle .img-i[![aristotle](img/aristotle.png)]

_A convincing argument contains character, emotion and logic. Ethos, pathos and logos._

_Tips:_

 * Show empathy and good intent to gain credibility
 * Describe and exemplify to elicit emotion
 * Back up your points and conclusions, link to data

---

## Fairy dust - Sinek .img-i[![sinek](img/sinek.png)]

_People don't buy _ what _ you do, they buy _ why _ you do it _

.center[<iframe width="420" height="315" src="https://www.youtube.com/embed/l5Tw0PGcyN0" frameborder="0" allowfullscreen></iframe>]

_Tips:_

 * Bring up why you implemented or documented your subject in the first place

---

 ## Fairy dust - Orwell .img-i[![quill](img/quill.png)]

* _Never use a metaphor, simile, or figure of speech that you often see in print._<br />
* _Never use a long word where a short one will do._<br />
* _If it is possible to cut out a word, always cut it out._<br />
* _Never use the passive where you can use the active._<br />
* _Never use a foreign phrase, or jargon if you have an everyday equivalent._<br />
* _Break any of these rules sooner than writing anything outright barbarous._<br />

_Tips:_

 * They're more what you'd call... guidelines, than actual rules.

---

 ## Surprise fairy dust! .img-i[![me](img/thi.png)]

 Cull uncertain words like _seems_, _appears_, _might_, _could_, etc.


 It could perhaps appear to be seemingly unnecessary to sometimes have maybe just a bit too many of them.

---

 ## Fairy dust - You .img-i[![selfie](img/selfie.png)]

 Be yourself, don't drown your style in that of others

 _Tips:_

 * Don't worry about _making_ your own style, it's something that _happens_

---

# Tech blog checklist

`-[]` Do you have an enticing opening? (Title/Subtitle/Kicker) <br />
`-[]` Does your title stand on its own? (To the point, not cryptic) <br />
`-[]` Do you have a concluding wrap-up? (Final summary, point back to the kicker) <br />
`-[]` Can people act upon your post? (Link to further resources, discussions, etc.) <br />
`-[]` Is there a sprinkle of colour in your language? (Similes, metaphors, etc.) <br />
`-[]` Do you have a witty tweetable wrap-up in there? (Just for fun) <br />

---


class: center, middle

.img-m[![praqma logo](img/praqma-logo.png)]
# Now get out there and write!


    </textarea>
    <script src="https://remarkjs.com/downloads/remark-latest.min.js">
    </script>
    <script>
        var slideshow = remark.create();
    </script>
</body>

</html>