Style d'écriture de mon jardin numérique

Contenu :

Note : j’essaie aussi de suivre ce style d’écriture dans les documentations, les issues et commentaires que je publie dans ma vie personnelle et professionnelle.

Optimisé pour la lecture rapide ¶

J’essaie de structurer le contenu des articles pour permettre aux lecteurs de naviguer rapidement vers les sections qui les intéressent (voir aussi Make your text skimable).

J’essaie d’éviter d’enfouir les idées dans de la prose pour permettre aux lecteurs de trouver rapidement les réponses à des questions précises.

Je place des liens ancrés sur tous les titres pour permettre de partager les articles directement au bon endroit dans la page.

J’essaie d’être explicite ¶

Pour cela, contrairement à de la littérature, je n’hésite pas à faire des répétitions d’idées ou de mots.

Dès que l’utilisation d’un pronom peut être ambigu, je remplace ce pronom par ce qu’il représente.

Si j’utilise un acronyme, j’indique entre parenthèse ce qu’il veut dire ou je place un lien vers sa définition.

J’essaie d’intégrer systématiquement des exemples dans mes textes.
Pourquoi ? Eh bien, d’après mon expérience (je l’ai aussi lu, mais je ne retrouve plus les références), j’observe qu’un ou deux exemples sont plus simples à comprendre qu’une définition formelle.

Effort d’objectivité ¶

J’essaie autant que possible de placer des marqueurs de modestie épistémique dans mes textes.

Utilisation du vouvoiement ou du tutoiement ? ¶

J’ai décidé arbitrairement d’utiliser le vouvoiement dans tous les articles de https://sklein.xyz.