Charte de la documentation Jedi

"Clair, ton contenu doit être. Confus, il ne sera pas." – Yoda, maître de style

Objectif

Garantir une qualité de documentation digne du Temple Jedi (et éviter que les lecteurs deviennent fous en lisant tes notes).

Principes fondamentaux :

  • Un titre clair : pas de “Misc_v3_notes”, merci.

  • Une intro contextuelle : le pourquoi, avant le comment.

  • Des listes bien structurées : comme celle-ci.

  • Screenshots si besoin : pas d’excuse, même Chewbacca sait faire une capture d’écran.

  • Pas de blagues internes obscures : si seuls 2 padawans comprennent, ça va direct au Databloc Interdit.

Style de langue

  • Tu t’adresses à un autre Jedi → "tu", simple, direct.

  • Pas de jargon inutile. Si tu écris “implémentation holistique d’une stratégie de diffusion de l’information intergalactique”, tu es un Sith.

    Aaaaa

Cet article vous a-t-il aidé ?