Quick Menu

Guide de rédaction de la documentation des applications

Page de documentation utilisateurs·rices / administrateurs⋅rices

Ajouter un bouton installer en un clic (comme par exemple : https://yunohost.org/app_piwigo) et un bouton sur le niveau d'intégration de l'application.

Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc.).

Quelques usages types et d'ordre général (trame de rédaction)

  • Lorsqu'un lien renvoie vers une page qui n'est pas dans la langue de la page d'origine, il est d'usage d'ajouter (en)(Pour un lien qui pointe vers une page en anglais).
  • renommer les images dans l'ordre suivant : nomapplication_descriptif.ext

Feuille de route

  1. Documenter les applications.
    1. Documenter les applications au travail (marqué : work) niveau 8/7/6.
    2. Traduire la page de documentation a minima en français et en anglais.
    3. Faire une PR sur le dépôt de l'application concernée vers la page de documentation.

Vous avez découvert des erreurs ? Vous pensez pouvoir améliorer cette documentation ? Cliquez sur Éditer en haut de la page, puis sur l'icone crayon sur Github pour proposer vos changements.