User:TBurmeister (WMF)/Sandbox/Doc-journeys

The following user journeys ^[1]evolved out of our research into user personas, motivations, and the tasks that users are trying to complete when they seek documentation. The information architecture of the developer portal implements these goals and tasks as site sections and links to key landing pages. Read more about this in our corresponding blog post on Diff.

Get started edit

Learn how Wikimedia software projects work edit

Browse tutorials edit

Learn about Wikimedia technology edit

Browse by programming language edit

Use content or data edit

Use content and data edit

Explore featured apps edit

Learn with tutorials edit

Use wiki content edit

Access open data edit

Build and discover tools edit

Discover and share tools edit

Browse the catalog of tools on Toolhub, share your tools, and help maintain tool metadata.

TODO: First subsection doesn't have action header (breaks the pattern). There's not enough content to justify using this precious dev portal real estate only on Toolhub...both links in this section go to the same place.

Toolhub (Browse tools) edit

Toolhub is a catalog of tools that make it easier to edit and maintain Wikimedia projects. Use Toolhub to discover new tools, connect with tool maintainers, and share lists of your favorite tools.

https://toolhub.wikimedia.org/

Share a tool edit

Add your tool to the Toolhub catalog so others can benefit from and build on your work. Log in to Toolhub with your Wikimedia account to get started.

https://toolhub.wikimedia.org/add-or-remove-tools?tab=tool-create

Get started building tools edit

Create your first tool, learn about running a bot, and get best practices.

Build your first tool edit

Learn how to edit wiki pages using Python and the Pywikibot framework. This tutorial helps you get started quickly using only your browser.

https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/PAWS

Learn about creating and running bots edit

Bots help maintain wikis by performing repetitive tasks. Get started creating and running bots by learning about best practices.

https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Creating_a_bot

Best practices for open source tools edit

New to open source? Get tips to help you develop successful tools and bots, including choosing a license, publishing the code, and writing docs.

https://wikitech.wikimedia.org/wiki/Help:Toolforge/Developing_successful_tools

Learn with tutorials edit

Follow step-by-step guides to learn the basics of interacting with Wikimedia projects.

Build your first tool edit

Learn how to edit wiki pages using Python and the Pywikibot framework. This tutorial helps you get started quickly using only your browser.

https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/PAWS

Generate ideas for articles edit

Learn how to use the MediaWiki API to generate ideas for new Wikipedia articles. This tutorial uses Python and the Flask framework.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Article_ideas_generator

Write a bot that uses Wikidata edit

Use Python to handle large datasets from Wikidata and transfer data between tools in your workflow.

https://www.wikidata.org/wiki/Special:MyLanguage/Wikidata:Pywikibot_-_Python_3_Tutorial

Display holidays from Wikipedia edit

Learn how to use the MediaWiki API to fetch holidays for a given date from Wikipedia. This tutorial also covers how to use the API to log in to Wikipedia and add new holidays. This tutorial uses Python and the Flask framework.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Holidays_viewer

Add JavaScript or CSS to a wiki edit

Customize MediaWiki with client-side JavaScript and CSS. Share user scripts, and explore gadgets other people have created.

https://www.mediawiki.org/wiki/Special:MyLanguage/Gadget_kitchen

Host a tool on Wikimedia cloud servers edit

TODO: In retrospect, this seems odd in this section of the Dev Portal

Toolforge is a free hosting environment for running and managing tools. Get started with Toolforge by creating an account and setting up a basic web service.

https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Quickstart

Use APIs and data sources edit

Explore programming interfaces for building bots and tools.

Pywikibot edit

Pywikibot is a Python library and collection of scripts that automate work on Wikimedia projects.

https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot

https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/Development

https://gerrit.wikimedia.org/g/pywikibot/core

Browse libraries by programming language edit

API client libraries make it easier to write code that interacts with an API. Visit this list to browse popular libraries for the MediaWiki API by programming language.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Client_code

Use the API edit

The MediaWiki API gives you programmatic access to content on any Wikimedia wiki. You can use the API to search and display wiki pages, get media files, edit pages, and manage wikis.

https://www.mediawiki.org/wiki/Special:MyLanguage/API

https://www.mediawiki.org/wiki/Special:ApiSandbox

Download content in bulk edit

Access free downloads of wiki content and data that you can use in research, offline reading, bot editing, and other projects.

https://meta.wikimedia.org/wiki/Special:MyLanguage/Data_dumps

Query wiki databases edit

Wiki replicas are anonymized versions of the databases that back Wikimedia's production sites. Use Quarry to run and share SQL queries.

https://quarry.wmcloud.org/

https://meta.wikimedia.org/wiki/Special:MyLanguage/Research:Quarry

Host tools on Wikimedia servers edit

Access cloud services for performing analytics, administering bots, running web services, and hosting tools that help Wikimedia projects.

Run scripts in your browser edit

PAWS is a free, cloud-hosted playground for creating scripts and data visualizations related to Wikimedia projects. Log in with your Wikimedia account and create a notebook to get started.

https://hub.paws.wmcloud.org/hub/login

https://wikitech.wikimedia.org/wiki/PAWS

Learn about cloud hosting for tools edit

Toolforge is a free hosting environment for running and managing tools. Developing a tool in Toolforge makes it easier to access Wikimedia content and data and to share your tool with others.

https://wikitech.wikimedia.org/wiki/Portal:Toolforge

Contribute to Wikimedia open source edit

Learn how contributing works edit

Contribute by topic edit

Contribute by programming language edit

Search Wikimedia open source projects edit

Connect and learn edit

Note: many of the landing pages this leads to aren't really technical documentation.

Connect at hackathons and events edit

Communicate with the tech community edit

Learn and share technical skills edit

Get tech project updates edit

Learn about Wikimedia technical operations edit

↑ Technical writers use user journeys as a framework for information design that follows the principles of minimalism (or task-orientation), and layering (or progressive disclosure).

[1] Technical writers use user journeys as a framework for information design that follows the principles of minimalism (or task-orientation), and layering (or progressive disclosure).

[1]