説明文書

From mediawiki.org
This page is a translated version of the page Documentation and the translation is 83% complete.



概要

技術文書とは、技術的な製品、プロセス、またはタスクに関する情報を含むすべての文書を指します。

ウィキメディア・プロジェクトの文書は、さまざまなウィキやウェブサイトに広く分散しています。 このページでは、MediaWiki および関連ソフトウェアの技術ドキュメントを中心に紹介しています。

Why contribute to technical documentation?

Technical documentation is an important part of Wikimedia technical projects. Quality documentation is especially important for open-source projects where folks from all over the world are working together. It provides history, context, accurate information, and repeatable steps that people can follow.

If you are interested in contributing to Wikimedia's technical projects, improving technical documentation can be a good starting place.

Where to find Wikimedia technical documentation

There are many Wikimedia technical projects, and sometimes it can be difficult to determine the best place to find or publish technical documentation. Following is a list of the main places to find Wikimedia technical documentation.

  • MediaWiki - MediaWiki software documentation and technical documentation for many other Wikimedia technology projects. This is the default space for publishing technical documents about Wikimedia technology.
  • Wikitech - Technical documentation for Wikimedia Foundation infrastructure and services. This includes production clusters, Wikimedia Cloud Services, Toolforge hosting, the Beta Cluster, and other data services.
  • Wikidata - Technical documentation related to the Wikidata project, particularly the Tools page.
  • PAWS - Documentation about PAWS, Wikimedia's hosted Jupyter notebooks instance. Notebooks are frequently used to create tutorials and documentation for Wikimedia technology.
  • Phabricator - Phabricator is a collaboration tool that is used by the Wikimedia technical community for task and bug management. You can find many issues and software projects documented here. Use best practices for software documentation when filing tasks and interacting in this space.

Who uses Wikimedia technical documentation?

Explore Audiences for Wikimedia technical documentation to find out about the types of people who use Wikimedia technical documentation and their motivations.

ドキュメントの構成

MediaWiki.org
  • プロジェクトベースのドキュメント:特定のプロジェクトに関連するユーザーガイド、APIドキュメント、チュートリアル、開発情報、参考資料など。
Autogenerated docs
Other docs
  • /docs directory - The 'docs' directory contains various text files that explain the most important parts of the code of MediaWiki.

Get started

New to technical documentation on Wikimedia projects? This page will help you get started right away.