Guide de rédaction (wiki)
| stock}} |
Contenu
Ce wiki est destiné aux partenaires et aux clients.
- Ne pas inclure d'informations confidentielles.
- Ne pas inclure d'informations de développement.
- Ne pas documenter des fonctions qui n'existent pas.
- Ne pas supposer que le lecteur est un expert ou un abruti.
- Ecrire en français
- Vérifier l’orthographe.
Pages
- Le nom de la page doit être significatif et compréhensible
- Le nom de la page doit inclure la rubrique
- Exemple : Paquet métier (model)
- Toutes les pages doivent être dans au moins une catégorie.
- Ajouter les catégories à la fin de la page
- Eviter les pages énormes
Titres
- Commencer à H2 ==
- Ne pas inclure de titre principale reprenant le nom de la page
Images et vidéos
Utiliser les templates
{{#images:nom_fichier|répertoire}}
{{#videos:nom_fichier|répertoire|Titre de la vidéo}}
{{#flashs:nom_de_fichier|répertoire|Titre de la vidéo}}
- Tous les noms de fichier et répertoire doivent être en minuscule (impératifs).
- Ne pas utiliser d'accents dans les noms de fichier et répertoire.
Utiliser le upload mediawiki
- Possible pour les images mais pas pour les vidéos.
Encodage des images
- Encoder les images en PNG.
Encodage des vidéos
- Utiliser un codec LoosLess pour l'enregistrement.
Exemple : CamStudio options :
{{#images:image1.png|guide-redaction}}
- Encoder les vidéos en h264 et sortie flash en utilisant ffmpeg
Exemple :
ffmpeg -i %1.avi -qscale 10 -vcodec libx264 %1.flv
Nouveauté version
- Inclure le template new pour afficher une image "nouveauté"
Exemple :
__TOC__
{{new|Tahoe}}
...
[[category:Tahoe]]
- Inclure la page dans la catégorie de la version
- Ajouter une entrée dans la page récapitulative de la version
- Ajouter un pictogramme de version dans le corps du texte avec le template du nom de la version {{#images:versionTahoe-32x32.png|stock}}
Exemple :
* [[Importation de documents (import)|Importation de documents]] {{Tahoe}}
Ne pas écrire le nom de version dans le corps de texte.