説明文書

概要

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.

説明文書ページ

• 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

• MediaWiki.org 上で:
  • A Technical Manual for information about the MediaWiki Software.
  • プロジェクトベースのドキュメント。 This includes user guides, API documentation, tutorials, development information and reference materials related to specific projects.
  • Help pages contain end-user specific documentation and 特別ページ provide some on-demand documentation.
• Auto-generated API documentation:
  • Action API reference
  • REST API reference
• 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)
  Help:コンテンツ at mediawiki.org and meta are concise forms of end-user documentation.
• System administrators
  Pages linked to Category:MediaWiki for site admins and システム管理者ハブ contain sysadmin specific information. Manual:Contents serves as the reference guide.
• Wiki administrators
  MediaWiki Administrator's Handbook and Manual:管理者 contain resources for administrators. Manual:コンテンツ serves as the reference guide.
• Developers
  • Code developers and administrators
    New Developers , Manual:コンテンツ and linked pages are a starting point for beginners. Experienced developers refer to 開発者ハブ .
  • Add-ons developers
    References include 開発者ハブ , Manual:拡張機能 , カテゴリ:拡張機能 , Gadget kitchen , Manual:ボット , etc., besides the software installation guidelines.
  • Designers
    Pages linked to Design .
  • Translators and technical writers
    翻訳者ハブ and Help:コンテンツ for getting started followed by the project specific mediawiki pages.

Hackathons and outreach

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