Inviato da HKR il Lun, 06/20/2016 - 07:37
Revisione di Ajouter un nouveau manuel d'aide del Lun, 06/20/2016 - 11:19
Le revisioni permettono di tenere traccia delle differenze tra le diverse versioni di un contenuto.
La documentation de Trisquel doit rester le plus structurée que possible pour faciliter ses modifications, sa maintenabilité dans le temps ainsi que la navigation vers un manuel précis.
Pour y arriver voici quelques conseils d'édition :
- Évitez de documenter deux fois la même chose dans deux bouts de Wiki différents. On préfèrera créer une nouvelle documentation factorisant les points communs entre ces Wikis et mettre un lien de cette nouvelle documentation dans chaque Wiki concerné.
- Chaque documentation est un manuel enfant de la Liste des manuels par ordre alphabétique. Ainsi on est certain que tous les manuels seront listés quelque part et au même endroit. Sur la même page (dans l'arborescence) ajouter votre nouvelle documentation dans l'une des thématiques déjà présentes. Si elle n'existe pas n'hésitez pas à la créer. Si votre nouveau manuel recoupe plusieurs thématiques vous pouvez la mettre dans plusieurs thématiques. Cela en facilitera grandement la recherche.
- Pour faciliter la navigation vers un manuel créez une page de manuel regroupant d'autres manuels en fonction d'une thématique par exemple la thématique Matériel.
- Chaque thématique doit être listée dans un Manuel et dans la Liste des manuels par ordre alphabétique (dans l'arborescence ainsi que dans la liste par ordre alphabétique).
