o42nvq
Last Updated: February 25, 2016
·
7.523K
· mcansky
892a174c18182a2a3157e51cd071d1cf

Write better Protips

Dear fellow writers,

You are publishing really good pro tips, really.

Yet, please let me give you some tips about writing interesting and useful tips for your readers and your future self.

  1. Write a short introduction : even a line is enough to explain classic use case of the tip, where it's coming from
  2. Explain the tip : do not simply copy and paste a line of code or some super crazy shell fu : explain it. In my point of view it's always good to explain a little what's going on there.
  3. Cite your sources : you are not covering some high risk topic, technical sources are a way for readers to check a bit more about the tip and what you are describing (or using)

There is mainly three reasons to add such things :

  1. It forces you to read the tip again and think about it, you'll avoid some errors
  2. It will be easier for readers, not coming from the same background and mind state as you do to understand it
  3. It will help your future self, facing a similar problem, to remember how that tip's content came to be

That said : thank you for all your pro tips, several of them already made my life easier : please keep writing !

Say Thanks
Respond

9 Responses
Add your response

2231
892a174c18182a2a3157e51cd071d1cf

(somehow) related : http://stylemanual.org

over 1 year ago ·
3668
87402530330e8d1fb2ff707a6f4510ad

Good tips. All we do must be reviewed on some way!

over 1 year ago ·
6709
3dd58b1eac9406ae08099585c409316b

Great

over 1 year ago ·
8014
Foto perfil

Never saw in that way. Good tips, thanks. It will also works for me when writing other publications.

over 1 year ago ·
8316
892a174c18182a2a3157e51cd071d1cf

@summic , @andresroberto10 , @sasasoftware : you're welcome, thanks !

over 1 year ago ·
9611
C529419362b4f96cbb3200d31d3db243

Example would be nice ^_^

over 1 year ago ·
9642

Simple but essential. :)

over 1 year ago ·
11035
Ecb3acc2d246962361a4f8b3f7a6dd12

Nice, tips

over 1 year ago ·
17817
0 vrcz hgkuc4pky9rzb5f  tjm10grsbrcanf c8flvisfo8kj9tnygq38oxcpgnpn18qjlosiqht

graet

over 1 year ago ·