Documentation #66756
Charte éditoriale concernant la documentation
Statut:
Nouveau
Priorité:
Normal
Assigné à:
-
Catégorie:
-
Version cible:
-
Début:
29 juin 2022
Echéance:
% réalisé:
0%
Temps estimé:
Patch proposed:
Non
Planning:
Non
Club:
Non
Description
La doc c'est la sédimentation de différentes époques, différents rédacteurs et rédactrices, il serait intéressant de compiler dans une charte, un certain nombre de règles éditoriales à respecter.
Avec l'idée que ces règles soient respectées quand on rédige un nouveau contenu, mais aussi que chacun puisse corriger au fil de l'eau les choses non conformes dans la doc existante.
Exemple rapide de règles possibles :- Utiliser (dans le texte et pas le code) les guillemets typographiques « »
- Bonne utilisation des classes de note définies dans #66751
- écrire en majuscule les choses qui ne devront pas être copiées/collées telles quelles dans les exemples, genre form_var_MONCHAMP