Modele/fr
Un article de Milimail.
Sommaire |
Comment créer la documentation?
Consignes pour créer la documentation pour toute nouvelle extension
Il y a toujours une page française (/FR) et une page anglaise.
La documentation générale est à insérer dans S'informer/Doc utilisateur. Pour cela,
- éditer les pages anglaises et françaises correspondantes et y copier le squelette ci-dessous et le compléter.
- le sauvegarder.
Même principe pour la documentation technique à partir de Communauté/Doc technique.
En pied de page, sont situés:
- un lien de retour. Ne garder qu'un seul lien en fonction de la version FR/US de la page.
- un lien de traduction.
En entête de page, sont situés:
- un lien de retour. Ne garder qu'un seul lien en fonction de la version FR/US de la page.
Enfin, pensez à activer le lien des menus doc technique et doc utilisateur en supprimant les balises commentaires.
Nomenclature
- les noms des pages commencent par le nom de l'extension, de préférence similaire à celui du répertoire svn
- les pages utilisateurs sont suffixées par _user
- les pages techniques sont suffixées par _architecture
- les images sont suffixées par _image_description où description décrit de manière synthétique le contenu de l'image.
Insertion d'image
- insérer la balise [[Image:nomextension_image_description.jpg]]
- sauvegarder la page
- cliquer sur le lien de l'image pour arriver sur la page de téléchargement de cette image sur le serveur
Modèle documentation utilisateur
Présentation des fonctionnalités de l'extension XXXX
Présenter en quelques lignes les fonctionnalités
+ copie d'écran [[Image:nomextension_image_description.jpg]] (cliquer ensuite sur le lien de l'image pour arriver sur l'IHM de téléchargement sur le serveur d'une image)
+ liens pour en savoir plus, doc technique par exemple
lien interne en FR: Milimail
lien interne en US Milimail
lien externe Nom_lien_externe
Installation
- Cliquer ici pour télécharger les sources.
- Indiquer les étapes d'installation avec des copies d'écran
[[Image:nomextension_image_description.jpg]] (Copie d'écran suivie d'un descriptif)
- Etape 2
- Etape 3
Configuration
Indiquer quelles sont les possibilités de paramétrage + copie d'écran
Utilisation
chapitre 1
Indiquer comment utiliser les fonctionnalités avec copies d'écran
chapitre 2
Modèle documentation technique
Rappel des fonctionnalités
Présenter en quelques lignes les fonctionnalités
+ copie d'écran [[Image:nomextension_image_description.jpg]] (cliquer ensuite sur le lien de l'image pour arriver sur l'IHM de téléchargement sur le serveur d'une image)
Implémentation
Normes
Citer la norme de référence
Architecture
Présentation synthétique de l'architecture de l'extension
schémas de l'extension (schéma avec overlay)? + copie d'écran [[Image:nomextension_image_description.jpg]] (cliquer ensuite sur le lien de l'image pour arriver sur l'IHM de téléchargement sur le serveur d'une image)
