Dokumentacja

Przegląd

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.

Strony poświęcone dokumentacji

• Wytyczne co do stylu w dokumentacji MediaWiki
• Szablony do formatowania tekstu
• Zasoby dla piszących dokumentację techniczną
• Wytyczne do zadań związanych z pisaniem dokumentacji technicznej
• Rodzaje dokumentacji technicznych
• Przewodnik dla nowych twórców dokumentacji

Struktura dokumentacji

• Na MediaWiki.org :
  • Podręcznik techniczny z informacjami o oprogramowaniu MediaWiki.
  • 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 Strony specjalne provide some on-demand documentation.
• Automatycznie wygenerowana dokumentacja API:
  • Action API reference
  • REST API reference
• Dokumentacja wygenerowana z kodu źródłowego MediaWiki: doc.wikimedia.org.
• Pliki tekstowe w katalogu /docs kodu źródłowego MediaWiki.

Zasoby pomocnicze to między innymi blogi, strony dyskusji i fora.

Część dokumentacji jest przenoszona z meta.wikimedia.org. Zobacz MetaProject to transfer content to MediaWiki.org

Grupa odbiorców dokumentacji

Poniżej znajduje się lista głównych grup użytkowników MediaWiki oraz zestaw najważniejszych stron dla nich przeznaczonych.

• Wiki users (end users of the MediaWiki software)
  Pomoc:Spis treści at mediawiki.org and meta are concise forms of end-user documentation.
• System administrators
  Pages linked to Category:MediaWiki for site admins and Centrum administratorów systemu contain sysadmin specific information. Manual:Contents serves as the reference guide.
• Wiki administrators
  MediaWiki Administrator's Handbook and Podręcznik:Administratorzy contain resources for administrators. Podręcznik:Spis treści serves as the reference guide.
• Developers
  • Code developers and administrators
    Nowi Deweloperzy , Podręcznik:Spis treści and linked pages are a starting point for beginners. Experienced developers refer to Developer hub .
  • Add-ons developers
    References include Developer hub , Podręcznik:Rozszerzenia , Kategoria:Rozszerzenia , Gadget kitchen , Podręcznik:Boty , etc., besides the software installation guidelines.
  • Designers
    Pages linked to Design .
  • Translators and technical writers
    Centrum tłumaczy and Pomoc:Spis treści for getting started followed by the project specific mediawiki pages.

Hackathons and outreach

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