Jump to content

Documentation/sd: Difference between revisions

From mediawiki.org
Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
FuzzyBot (talk | contribs)
Bots
1,349,402 edits
Updating to match new version of source page
FuzzyBot (talk | contribs)
Bots
1,349,402 edits
Updating to match new version of source page
 
Line 16: Line 16:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Noun project navigate icon 22262.svg|50px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Find documentation</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Find documentation</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Wikimedia has many technical projects, so technical documentation exists in multiple locations.</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Wikimedia has many technical projects, so technical documentation exists in multiple locations.</span>
|footer =
|footer =
Line 23: Line 23:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Noun project 9866.svg|Noun project 9866|50px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Improve your documentation</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Improve documentation</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Use templates, best practices, and checklists to help you audit and improve docs.</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Use templates, best practices, and checklists to help you audit and improve docs.</span>
|footer =
|footer =
Line 30: Line 30:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Edit icon (the Noun Project 30184).svg|50px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Learn about writing</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Learn about writing</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Find style guides and tips to help you write clearly and effectively.</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Find style guides and tips to help you write clearly and effectively.</span>
|footer =
|footer =
→ {{ll|Documentation/Technical_style_guides_and_templates|2=<span lang="en" dir="ltr" class="mw-content-ltr">Browse style guides and writing resources</span>}}
→ {{ll|Documentation/Technical_style_guides_and_templates|2=<span lang="en" dir="ltr" class="mw-content-ltr">Browse writing resources</span>}}
}}
}}


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Noun project 6396.svg|50px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Get involved in doc work</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Get involved in doc work</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Help improve Wikimedia technical documentation, connect with the community, and learn about outreach programs.</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Help improve Wikimedia technical documentation, connect with the community, and learn about outreach programs.</span>
|footer =
|footer =
Line 44: Line 44:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Coordination - The Noun Project.svg|46px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Attend documentation events</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Attend documentation events</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Learn about upcoming documentation-related events and view slide decks and notes from past events.</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Learn about upcoming documentation-related events and view slide decks and notes from past events.</span>
|footer =
|footer =
Line 59: Line 59:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Communication icon (The Noun Project).svg|50px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Find help for documentation questions</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Find help for documentation questions</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Ask documentation questions on [[Talk:Documentation]], in {{IRC|wikimedia-techdocs}} on [https://libera.chat/ libera.chat], or in any of the forums listed on the [[Special:MyLanguage/Communication|Communication page]].</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Ask documentation questions on [[Talk:Documentation]], in {{IRC|wikimedia-techdocs}} on [https://libera.chat/ libera.chat], or in any of the forums listed on the [[Special:MyLanguage/Communication|Communication page]].</span>
|footer =
|footer =
Line 66: Line 66:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Crowdsourcing - The Noun Project.svg|46px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">Request documentation consultation or review</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">Request documentation consultation or review</span>
|content = {{tmpl|0=<span lang="en" dir="ltr" class="mw-content-ltr">Request a documentation [$1 consultation] or [$2 review] from the {{ll|Wikimedia Technical Documentation Team}}.</span>
|content = {{tmpl|0=<span lang="en" dir="ltr" class="mw-content-ltr">Request a documentation [$1 consultation] or [$2 review] from the {{ll|Wikimedia Technical Documentation Team}}.</span>
|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>.
|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>.
Line 86: Line 86:


{{InfoCard
{{InfoCard
|heading = <span aria-hidden="true">[[File:Noun project 2472.svg|50px|link=]]</span> <span lang="en" dir="ltr" class="mw-content-ltr">File documentation bugs or requests</span>
|heading = <span lang="en" dir="ltr" class="mw-content-ltr">File documentation bugs or requests</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Learn how and where to record potential doc tasks.</span>
|content = <span lang="en" dir="ltr" class="mw-content-ltr">Learn how and where to record potential doc tasks.</span>
|footer =
|footer =

Latest revision as of 21:46, 3 December 2024

Languages:

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.
→ Use the Developer Portal to find docs, or read about doc locations .

Improve documentation

Use templates, best practices, and checklists to help you audit and improve docs.
→ Visit the Documentation Toolkit

Learn about writing

Find style guides and tips to help you write clearly and effectively.
→ Browse writing resources

Get involved in doc work

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

Attend documentation events

Learn about upcoming documentation-related events and view slide decks and notes from past events.
→ Explore events

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.
→ See communication channels

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.
→ How to file doc tasks
Retrieved from "https://www.mediawiki.org/w/index.php?title=Documentation/sd&oldid=6885910"