Skip to content

Commit b6e1c2a

Browse files
committed
Extend style guidelines with additional examples
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent da74ff4 commit b6e1c2a

File tree

1 file changed

+47
-10
lines changed

1 file changed

+47
-10
lines changed

README.md

+47-10
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,66 @@ If necessary show acknowledgements to others who collaborated or gave feedback y
3232

3333
* Headings
3434

35-
When using steps use the active/imperative voice for headings "Get started" vs "Getting started", "Configure the node" vs "Configuring the node" etc.
35+
When using steps use the active/imperative voice for headings.
36+
37+
Good:
38+
39+
* "Get started"
40+
* "Configure the node"
41+
42+
Bad:
43+
44+
* "Getting started"
45+
* "Configuring the node"
46+
47+
#### Use Plain English
48+
49+
English is widely spoken, but is not the first language of all readers. This publication also covers many technical topics, you may be an expert, but your readers are unlikely to be, so consider both of these when you write your article.
50+
51+
Write in plain English at all times, when a simpler word exists use it, avoid words derived from Latin when possible, avoid gerunds where an active verb can replace it.
52+
53+
If you are writing an article, then your voice should be coming across, and your experience. That is why you are writing the post - try to avoid using passive tense or statements, where you can use a sentence that starts with `I`.
54+
55+
Before:
56+
57+
* In any production service, logs are a critical component of observability and debuggability of the system
58+
59+
After:
60+
61+
* Logs are critical to observing and debugging systems once in production.
62+
* Logs are critical to observing and debugging production systems.
63+
64+
Use short sentences:
65+
66+
Before:
67+
68+
* This should ease your debugging experience with functions and the combination with Grafana also opens some additional possibilities, for example you can start creating dashboards for your functions that combine Prometheus metrics _and_ logs on the same screen by using the [new logs panel
69+
70+
After:
71+
72+
* The combination of Loki and Grafana make it even easier to debug functions than before. You can even create dashboards that combine function metrics and logs in one place.
73+
74+
For some additional recommendations see:
75+
76+
* [This post](https://www.cs.uky.edu/~raphael/writing.html), by Raphael A. Finkel, University of Kentucky.
77+
78+
* And [Before & After]http://www.plainenglish.co.uk/campaigning/examples/before-and-after.html] from plainenglish.co.uk
3679

3780
#### Tone / style
3881

3982
* Be objective, avoid being "cute"
4083

4184
Whilst using fun terms like "Boom!", "Fun and profit" and making jokes in text, can work well on a personal blog. The OpenFaaS blog and documentation should have a minimal use of this kind of "fun" or "cute" terms.
4285

43-
* Quote your sources
44-
45-
If you use a diagram or embed a quote from somewhere, make sure you give it [proper attribution](https://en.wikipedia.org/wiki/Attribution_(copyright)).
46-
4786
* Opinion vs. facts
4887

49-
Opinions should be presented as your own viewpoint. If you have data to back-up your position, this will help make your point credible.
88+
Opinions should be presented as your own viewpoint. If you have data to back-up your position, this will help make your point credible. If you have no data, then make sure the reader understands this by relating to yourself `I believe that ..`, `I found it easier to ..`
5089

5190
If you are stating a fact / objective data, you should also back this up with quotes, links, etc.
5291

53-
* Plain English
54-
55-
Write in plain English at all times, when a simpler word exists use it, avoid words derived from Latin when possible, avoid gerunds where an active verb can replace it.
92+
* Quote your sources
5693

57-
> For some additional recommendations see [this post](https://www.cs.uky.edu/~raphael/writing.html), by Raphael A. Finkel, University of Kentucky.
94+
Beware of copyright laws. If you use a diagram or embed a quote from somewhere, make sure you give it [proper attribution](https://en.wikipedia.org/wiki/Attribution_(copyright)).
5895

5996
#### Images
6097

0 commit comments

Comments
 (0)