Documentação

Overview

Technical documentation refers to any documentation that contains information regarding a technical product, process, or task.

Documentation for Wikimedia projects is widely spread across different wikis and websites. This page focuses on technical documentation for MediaWiki and related software.

Documentation pages

• MediaWiki documentation style guide
• Templates for formatting text
• Resources for technical documentarians
• Guidelines for technical documentation tasks
• Different technical writing genres
• A guide for new technical writers

Documentation structure

• On MediaWiki.org :
  • A Technical Manual for information about the MediaWiki Software.
  • Project based documentation. This includes user guides, API documentation, tutorials, development information and reference materials related to specific projects.
  • Help pages contain end-user specific documentation and Special pages provide some on-demand documentation.
• Auto-generated API documentation:
  • Action API reference
  • REST API reference

• Para muitas partes do MediaWiki, está disponível documentação gerada a partir do próprio código fonte do MediaWiki.

• 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)
  Ajuda:Conteúdos at mediawiki.org and meta are concise forms of end-user documentation.
• System administrators
  Pages linked to Category:MediaWiki for site admins and Portal dos administradores de sistema 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:Conteúdos serves as the reference guide.
• Developers
  • Code developers and administrators
    Novos Programadores , Manual:Conteúdos and linked pages are a starting point for beginners. Experienced developers refer to Portal dos Programadores .
  • Add-ons developers
    References include Portal dos Programadores , Manual:Extensões , Categoria:Extensões , Gadget kitchen , Manual:Bots , etc., besides the software installation guidelines.
  • Designers
    Pages linked to Design .
  • Translators and technical writers
    Portal do Tradutor and Ajuda:Conteúdos for getting started followed by the project specific mediawiki pages.

Hackathons and outreach

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