Documentation

Aperçu

La documentation technique fait référence à toute documentation contenant des informations ayant rapport à un produit technique, un processus, ou une tâche.

La documentation des projets Wikimedia est largement répartie sur les différents wikis et les sites web. Cette page traite de la documentation technique pour MediaWiki et les logiciels associés.

Pages de documentation

• Guide du style de la documentation MediaWiki
• Modèles pour formater le texte
• Ressources pour les documentalistes techniques
• Directives pour les tâches de documentation technique
• Différents genres d'écriture technique
• Guide pour les rédacteurs techniques

Structure de la documentation

• Sur MediaWiki.org  :
  • Manuel technique pour les informations à propos du logiciel MediaWiki.
  • Documentation basée sur le projet. Cela inclut les guides utilisateurs, la documentation de l'API, les tutoriels, les informations du développement et les matériels de référence relatifs aux projets spécifiques.
  • Les pages d'aide contiennent la documentation de l'utilisateur final et Pages spéciales fournit quelques documents à la demande.
• Documentation de l'API générée automatiquement :
  • Références de l'API Action
  • Références de l'API REST
• Documentation générée à partir du code source de MediaWiki : doc.wikimedia.org .
• Les fichiers texte du répertoire /docs de l'arborescence des sources MediaWiki possèdent les informations relatives au code.

La prise en charge des resources comprend les blogs, les pages de discussion et les forums de discussion.

Quelques documents qui n'ont pas encore été migrés de meta.wikimedia.org. Voir le MetaProject pour transférer le contenu vers MediaWiki.org

Public concerné par la documentation

Les utilisateurs initiaux de la documentation MediaWiki et l'ensemble le plus utile de pages pour chaque groupe utilisateur sont listés ci-dessous.

• Wiki users (end users of the MediaWiki software)
  Aide:Sommaire at mediawiki.org and meta are concise forms of end-user documentation.
• System administrators
  Pages linked to Category:MediaWiki for site admins and Pôle des administrateurs système contain sysadmin specific information. Manual:Contents serves as the reference guide.
• Wiki administrators
  MediaWiki Administrator's Handbook and Manuel:Administrateurs contain resources for administrators. Manuel:Contenu serves as the reference guide.
• Developers
  • Code developers and administrators
    Nouveaux développeurs , Manuel:Contenu and linked pages are a starting point for beginners. Experienced developers refer to Pôle des développeurs .
  • Add-ons developers
    References include Pôle des développeurs , Manuel:Extensions , Catégorie:Extensions , Gadget de cuisine , Manuel:Robots , etc., besides the software installation guidelines.
  • Designers
    Pages linked to Design .
  • Translators and technical writers
    Pôle des traducteurs and Aide:Sommaire for getting started followed by the project specific mediawiki pages.

Hackathons et sensibilisation

• Technical Documentation Tasks for Hack-a-thons
• Season of Docs