http://www.carnivault.org/index.php?action=history&feed=atom&title=DocumentationDocumentation - Revision history2026-04-21T14:46:10ZRevision history for this page on the wikiMediaWiki 1.42.5http://www.carnivault.org/index.php?title=Documentation&diff=1319&oldid=prevNepenthesOdyssey: 1 revision imported2025-02-25T09:35:23Z<p>1 revision imported</p>
<p><b>New page</b></p><div><languages/><br />
<translate><!--T:50--> This page introduces the basics of Wikimedia technical documentation.</translate><br />
<translate><!--T:51--> 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.</translate><br />
<br />
<translate><br />
== What is technical documentation? == <!--T:52--><br />
</translate><br />
<translate><!--T:23--> [[w:Technical documentation|Technical documentation]] refers to any documentation that contains information regarding a technical product, process, or task.</translate><br />
<translate><!--T:25--> This page focuses on technical documentation for [[<tvar name=1>Special:MyLanguage/MediaWiki</tvar>|MediaWiki]] and related software, including the infrastructure, tools and other technologies that power [<tvar name=url>https://www.wikimedia.org/</tvar> Wikimedia projects].</translate><br />
<br />
<translate><br />
== Get started == <!--T:55--><br />
</translate><br />
{{ContentGrid<br />
|content=<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:56--> Find documentation</translate><br />
|content = <translate><!--T:57--> Wikimedia has many technical projects, so technical documentation exists in multiple locations.</translate><br />
|footer =<br />
→ <translate><!--T:58--> Use the [<tvar name="url">https://developer.wikimedia.org/</tvar> Developer Portal] to find docs, or {{<tvar name="1">ll|Documentation/Find_docs</tvar>|read about doc locations}}.</translate><br />
}}<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:59--> Improve documentation</translate><br />
|content = <translate><!--T:60--> Use templates, best practices, and checklists to help you audit and improve docs</translate><br />
|footer =<br />
→ {{ll|Documentation/Toolkit|2=<translate><!--T:61--> Visit the Documentation Toolkit</translate>}}<br />
}}<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:62--> Learn about writing</translate><br />
|content = <translate><!--T:63--> Find style guides and tips to help you write clearly and effectively.</translate><br />
|footer =<br />
→ {{ll|Documentation/Technical_style_guides_and_templates|2=<translate><!--T:64--> Browse writing resources</translate>}}<br />
}}<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:65--> Get involved in doc work</translate><br />
|content = <translate><!--T:66--> Help improve Wikimedia technical documentation, connect with the community, and learn about outreach programs.</translate><br />
|footer =<br />
→ {{ll|Documentation/Contribute|2=<translate><!--T:67--> Get involved</translate>}}<br />
}}<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:77--> Attend documentation events</translate><br />
|content = <translate><!--T:78--> Learn about upcoming documentation-related events and view slide decks and notes from past events.</translate><br />
|footer =<br />
→ {{ll|Documentation/Events|2=<translate><!--T:79--> Explore events</translate>}}<br />
}}<br />
<br />
}}<br />
<br />
<translate><br />
<br />
== Get help == <!--T:68--><br />
</translate><br />
{{ContentGrid<br />
|content=<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:69--> Find help for documentation questions</translate><br />
|content = <translate><!--T:70--> Ask documentation questions on <tvar name="1">[[Talk:Documentation]]</tvar>, in <tvar name=3>{{IRC|wikimedia-techdocs}}</tvar> on <tvar name=4>[https://libera.chat/ libera.chat]</tvar>, or in any of the forums listed on the [[<tvar name="2">Special:MyLanguage/Communication</tvar>|Communication page]].</translate><br />
|footer = <br />
→ {{ll|Communication|2=<translate><!--T:71--> See communication channels</translate>}}<br />
}}<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:75--> Request documentation consultation or review</translate><br />
|content = {{tmpl|0=<translate><!--T:76--> Request a documentation [<tvar name=url>$1</tvar> consultation] or [<tvar name=url2>$2</tvar> review] from the <tvar name=1>{{ll|Wikimedia Technical Documentation Team}}</tvar>.</translate><br />
|1=https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?title={{urlencode:Consultation request: <documentation name>}}&owner=&description={{urlencode:I would like to request a consultation for <documentation name>.<br />
<br />
* Documentation location: <documentation link><br />
* Documentation audience: <intended audience for the documentation><br />
* Consultation subject: <consultation theme or your questions><br />
<br />
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=<br />
|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>.<br />
<br />
* Documentation location: <documentation link><br />
* Documentation audience: <intended audience for the documentation><br />
* Review focus area: <focus area:content/style/structure/accessibility/etc><br />
<br />
My preferred review format is: <Phabricator comment/IRC message (might be impossible due to timezone difference)/talk page topic/e-mail/other>.}}&projects=Tech-Docs-Team&subscribers=&template=&priority=&parent=<br />
}}<br />
}}<br />
<br />
{{InfoCard<br />
|heading = <translate><!--T:72--> File documentation bugs or requests</translate><br />
|content = <translate><!--T:73--> Learn how and where to record potential doc tasks.</translate><br />
|footer =<br />
→ {{ll|Documentation/Contribute/Filing_documentation_tasks|2=<translate><!--T:74--> How to file doc tasks</translate>}}<br />
}}<br />
<br />
}}<br />
<br />
[[Category:Documentation{{#translation:}}]]<br />
__NOTOC__</div>NepenthesOdyssey