Documentación

Resumen

Documentación técnica se refiere a cualquier documentación que contiene información con respecto a un producto técnico, proceso, o tarea.

La documentación para los proyectos Wikimedia están ampliamente repartidos por diferentes wikis y sitios web. Esta página se enfoca en la documentación técnica para MediaWiki y software relacionado.

Páginas de documentación

• MediaWiki documentation style guide
• Plantillas para formatear texto
• Resources for technical documentarians
• Guidelines for technical documentation tasks
• Different technical writing genres
• Guía para nuevos escritores técnicos

Estructura de documentación

• En MediaWiki.org :
  • Un Manual Técnico con información acerca del software MediaWiki.
  • Documentación basada en el proyecto. Esto incluye guías de usuarios, documentación API, tutoriales, información de desarrollo y materiales de referencia relacionados a proyectos específicos.
  • Páginas de ayuda contienen documentación específica para el usuario final, y Páginas especiales proporciona algunas documentación bajo demanda.
• Auto-generated API documentation:
  • Action API reference
  • REST API reference
• La documentación generada a partir del propio código fuente de MediaWiki: doc.wikimedia.org
• Text files in the /docs directory of MediaWiki source tree have code related information.

Supporting resources include blogs, talk pages and discussion forums.

Some documentation is yet to be migrated from meta.wikimedia.org. See MetaProject to transfer content to MediaWiki.org

Documentation audiences

Primary users of the MediaWiki documentation and the most useful set of pages for each user-group are listed below.

• Wiki users (end users of the MediaWiki software)
  Ayuda:Contenidos at mediawiki.org and meta are concise forms of end-user documentation.
• System administrators
  Pages linked to Category:MediaWiki for site admins and Sysadmin hub contain sysadmin specific information. Manual:Contents serves as the reference guide.
• Wiki administrators
  MediaWiki Administrator's Handbook and Manual:Administradores contain resources for administrators. Manual:Contenido serves as the reference guide.
• Developers
  • Code developers and administrators
    Desarrolladores nuevos , Manual:Contenido and linked pages are a starting point for beginners. Experienced developers refer to Centro del desarrollador .
  • Add-ons developers
    References include Centro del desarrollador , Manual:Extensiones , Categoría:Extensiones , Gadget kitchen , Manual:Bots , etc., besides the software installation guidelines.
  • Designers
    Pages linked to Design .
  • Translators and technical writers
    Punto de encuentro de traductores and Ayuda:Contenidos for getting started followed by the project specific mediawiki pages.

Hackathons and outreach

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