Documentation/uk

Огляд
Технічна документація відноситься до будь-якої документації, яка містить інформацію про технічний продукт, процес або завдання.

Документація для проєктів Вікімедіа широко поширена в різних вікі та веб-сайтах. Ця сторінка зосереджена на технічній документації на та пов’язаному ПЗ.

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.

Структура документації

 * На :
 * Технічний посібник для інформації про програмне забезпечення MediaWiki.
 * Проєктна документація. Це включає посібники користувача, документацію API, навчальні посібники, інформацію про розробку та довідкові матеріали, пов’язані з конкретними проєктами.
 * Довідкові сторінки конкретну документацію для кінцевого користувача, а  надають деяку документацію на вимогу.
 * Автоматично згенерована документація API:
 * Посилання на API дії
 * Посилання на REST API
 * Документація, згенерована з вихідного коду MediaWiki: doc.wikimedia.org.
 * Текстові файли в каталозі /docs вихідного дерева MediaWiki містять інформацію, пов’язану з кодом.

Допоміжні ресурси включають блоги, сторінки обговорень та дискусійні форуми.

Аудиторії документації
Основні користувачі документації MediaWiki та найкорисніший набір сторінок для кожної групи користувачів перераховані нижче.

at and meta are concise forms of end-user documentation. Pages linked to and  contain sysadmin specific information. Manual:Contents serves as the reference guide. MediaWiki Administrator's Handbook and contain resources for administrators. serves as the reference guide. , and linked pages are a starting point for beginners. Experienced developers refer to. References include, , , , , etc., besides the software installation guidelines. Pages linked to. and for getting started followed by the project specific mediawiki pages.
 * Wiki users (end users of the MediaWiki software)
 * System administrators
 * Wiki administrators
 * Developers
 * Code developers and administrators
 * Add-ons developers
 * Designers
 * Translators and technical writers

For a more comprehensive exploration of the types of people who use Wikimedia technical documentation and their motivations, see Audiences for Wikimedia technical documentation.

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