abuledu:developpeur:recommandations_de_redaction

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
abuledu:developpeur:recommandations_de_redaction [2008/11/26 17:46]
http://claimid.com/frucot
abuledu:developpeur:recommandations_de_redaction [2016/01/21 12:00] (Version actuelle)
erics
Ligne 1: Ligne 1:
 +{{tag>version-8-08}}
 ====== Recommandations pour la rédaction de la documentation AbulÉdu ====== ====== Recommandations pour la rédaction de la documentation AbulÉdu ======
  
 ===== Propos et idées ===== ===== Propos et idées =====
  
-Veillez à ce que vous écrivez soit bien en rapport avec le titre de l'article. Ne créez pas de hors-sujet ou de contresens. Au besoin n'hésitez pas à demander l'aide d'un relecteur sur [[web@abuledu.org|la liste de diffusion web]]. +Veillez à ce que vous écrivez soit bien en rapport avec le titre de l'article. Ne créez pas de hors-sujet ou de contresens. Au besoin n'hésitez pas à demander l'aide d'un relecteur sur le [[http://forum.abuledu.org|forum d'AbulÉdu]] et/ou [[web@abuledu.org|la liste de diffusion web]]. 
  
 Si vous sentez que vous faites un hors-sujet mais que l'idée vous paraît tout de même importante, créez une nouvelle page pour cette idée dans une section de la documentation ou dans le glossaire. Si vous sentez que vous faites un hors-sujet mais que l'idée vous paraît tout de même importante, créez une nouvelle page pour cette idée dans une section de la documentation ou dans le glossaire.
Ligne 45: Ligne 46:
     * et renvoyant vers tous les articles traitant chacun de la configuration détaillée (avec captures d'écran) d'une version donnée.     * et renvoyant vers tous les articles traitant chacun de la configuration détaillée (avec captures d'écran) d'une version donnée.
   * **Utilisez les titres et les sous-titres** : la table des matières est automatiquement générée à partir de ceux-ci, ils aident donc à se diriger dans un document lorsqu'on cherche une information très précise.   * **Utilisez les titres et les sous-titres** : la table des matières est automatiquement générée à partir de ceux-ci, ils aident donc à se diriger dans un document lorsqu'on cherche une information très précise.
-  * **Utilisez les annotations suivantes** (Vérifier, Illustrer, Compléter, Actualiser) afin de permettre une recherche plus rapide des pages à modifier. Idéalement, ces annotations seront placées entre les balises "codeet "/code"+  * **Utilisez les annotations suivantes** (Vérifier, Illustrer, Compléter, Actualiser) afin de permettre une recherche plus rapide des pages à modifier. Idéalement, ces annotations seront placées entre les balises %%<codeet </code>%%.
  
  
Ligne 74: Ligne 75:
 ==== Généralités sur DokuWiki ==== ==== Généralités sur DokuWiki ====
  
-Je n'ai pas encore réalisé la traduction / adaptation de la syntaxe de DokuWiki. Cependant, Les contributeurs du site [[http://www.ubuntu-fr.org|Ubuntu-FR]] en ont [[http://wiki.ubuntu-fr.org/wiki/syntax|une qui est excellente]], je vous conseille donc de la lire en attendant. Avec ça vous pourrez commencer à écrire des articles.+Je n'ai pas encore réalisé la traduction / adaptation de la syntaxe de DokuWiki. Cependant, Les contributeurs du site [[http://www.ubuntu-fr.org|Ubuntu-FR]] en ont [[http://doc.ubuntu-fr.org/wiki/syntaxe|une qui est excellente]], je vous conseille donc de la lire en attendant. Avec ça vous pourrez commencer à écrire des articles.
  
 Vous pouvez aussi «regarder le source d'une page((bouton en bas à gauche quand vous êtes visiteur))» ou «éditer une page((bouton en bas à gauche quand vous êtes identifié sur le site))» qui vous plait pour copier tout ou partie comme point de départ pour votre article. Vous pouvez aussi «regarder le source d'une page((bouton en bas à gauche quand vous êtes visiteur))» ou «éditer une page((bouton en bas à gauche quand vous êtes identifié sur le site))» qui vous plait pour copier tout ou partie comme point de départ pour votre article.
  • abuledu/developpeur/recommandations_de_redaction.1227717967.txt.gz
  • Dernière modification: 2008/11/26 17:46
  • de http://claimid.com/frucot