User Documentation Les éléments suivants définissent les exigences de base pour la mise en forme d'un article de documentation.
Références
Lignes directrices pour les contributeurs
Pages d'aperçu
Un article qui présente une section avec des introductions et des liens vers des sous-sections.
Paragraphe d'introduction
Liens vers les sections avec de brèves descriptions
- Utiliser un retrait pour mettre en forme chaque lien
- Le lien est identique à la façon dont il apparaît dans le menu.
- Le lien est suivi d'un tiret cadratin (espace-tiret cadratin-espace), puis d'une introduction d'une ou deux phrases à la sous-section décrivant comment elle développe le sujet global.
Le paragraphe de résumé relie la section à la catégorie, c'est-à-dire relie un sujet de gestion de contenu à Gestion de contenu.
Lien vers une sous-section
Liens de sous-section
Titres
Casse de titre
Mettre en majuscule
- Le premier et le dernier mot (toujours)
- Noms, verbes, adjectifs, adverbes
- Mots de 4 lettres ou plus (règle empirique courante)
Mettre en minuscule
- Prépositions courtes : en, sur, à, par, pour, de, vers
- Articles : un, une, le, la, les
- Conjonctions courtes : et, mais, ou, ni, donc, car
Exemple
Un guide des règles de la casse de titre et comment les utiliser
Esperluette &
À utiliser uniquement dans les menus comme substitut du mot « et », mais jamais dans les titres d'articles.
Lien de menu
6 Pagination & Lire la suite
Titre d'article
6 Pagination et Lire la suite
Numérotation
Lorsque le contenu suit un plan numéroté ou une structure d'index, ne pas ajouter de point à la fin d'un nombre.
Oui
6 Pagination et Lire la suite
Non
6. Pagination et Lire la suite
Étiquettes
- Tutoriel
- Gestion de contenu
- Création de site
- Maintenance du site
Captures d'écran
Se référer à Conseils pour de meilleures captures d'écran pour des indications détaillées.
Remarques : largeur de 1500 à 2500px ; arrière-plan de navigateur clair (pas sombre) ; recadrage approprié pour orienter l'utilisateur et afficher les détails pertinents ; zoom du navigateur pour améliorer le texte ; format de fichier PNG.
Légendes
Lorsqu'une légende est configurée (clic droit et cocher la case de légende), l'image est enveloppée dans un bloc <figure> avec une légende appropriée ; sinon, l'image est affichée dans une condition standard en ligne.
Emplacement
Taille
Largeurs standard : 960px pour la pleine largeur, et 320px ou 640px pour les largeurs partielles.
Les grandes largeurs (supérieures à 1000px) sont automatiquement redimensionnées dans le navigateur à la largeur de l'article. Les images plus petites sont alignées à gauche.
Attribution
Si la capture d'écran comprend des images, devrions-nous attribuer la source ? Et comment ?