Documentation/sd: Difference between revisions

Content deleted Content added

Inline

Revision as of 22:48, 13 November 2024

This page introduces the basics of Wikimedia technical documentation. It links to resources to help you find technical documentation, improve your docs or your writing, and get involved in contributing to Wikimedia technical documentation efforts.

What is technical documentation?

Technical documentation refers to any documentation that contains information regarding a technical product, process, or task. This page focuses on technical documentation for MediaWiki and related software, including the infrastructure, tools and other technologies that power Wikimedia projects.

Get started

Find documentation

Wikimedia has many technical projects, so technical documentation exists in multiple locations.

Improve your documentation

Use templates, best practices, and checklists to help you audit and improve docs.

Learn about writing

Find style guides and tips to help you write clearly and effectively.

Get involved in doc work

Help improve Wikimedia technical documentation, connect with the community, and learn about outreach programs.

Get help

Find help for documentation questions

Ask documentation questions on Talk:Documentation, in #wikimedia-techdocs ^connect on libera.chat, or in any of the forums listed on the Communication page.

Request documentation consultation or review

Request a documentation consultation or review from the Wikimedia Technical Documentation Team.

File documentation bugs or requests

Learn how and where to record potential doc tasks.

@@ Line 67: / Line 67: @@
 * Consultation subject: <consultation theme or your questions>
-My preferred format for this consultation is: <Phabricator comment/IRC conversation (might be impossible due to time difference)/talk page topic/e-mail/Phabricator comment/other>.}}&projects=Tech-Docs-Team&subscribers=&template=&priority=&parent=
+My preferred format for this consultation is: <Phabricator comment/IRC conversation (might be impossible due to time difference)/talk page topic/e-mail/other>.}}&projects=Tech-Docs-Team&subscribers=&template=&priority=&parent=
 |2=https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?title={{urlencode:Review request: <documentation name>}}&owner=&description={{urlencode:I would like to request a review for <documentation name>.