Page MenuHomePhabricator

Catalogue and improve documentation related to Technical Collaboration
Closed, ResolvedPublic

Description

For this task, "documentation related to Technical Collaboration" is defined as public wiki pages that are instructional in nature, whose topics are subjects covered by the Technical Collaboration Guidance. Examples of topics would be: how to request a translation, how to edit wiki pages, how to send a mass message, how to use a talk page (Flow and non-Flow), etc.

Problem: the documentation that exists to help people reach out to Wikimedia communities when seeking technical collaboration is spread out across multiple wikis (in some cases, multiple namespaces within one wiki), provide different levels of detail as far as technical detail is concerned, and have different levels of overall readability. Even if someone knows what they want to learn about, overchoice can be an issue.

Solution:

  1. Index the pages (T161018)
  2. Assess the pages (T161025)
  3. Merge duplication (if possible) (todo: create subtask)
  4. Improve as needed (todo: create subtask)
  5. Find out if any needed topics are not already covered (todo: create subtask)
  6. Only create new pages if absolutely necessary (todo: create subtask)

The resulting index should provide a navigable guide.

Event Timeline

Keegan triaged this task as Medium priority.Mar 16 2017, 7:24 PM
Keegan updated the task description. (Show Details)

How to edit a wiki page or how to use a Talk page look like too basic instructions for this scope, right? Community Liaisons edit wiki pages and use discussion pages, but these are not skills specific to CLs.

One example that we are discussing is T145843: Documentation about ways to gather community feedback, connected to the Technical Collaboration Guidance.

How to edit a wiki page or how to use a Talk page look like too basic instructions for this scope, right? Community Liaisons edit wiki pages and use discussion pages, but these are not skills specific to CLs.

Probably, yes.

Something that I thought about briefly when writing this task is that the guidance is a high-level overview with a lot of assumptions of experience. When the TCG recommends you contact a user on their talk page, we're assuming they know how to use a talk page. I'm not sure if this is a good thing or a bad thing, but that's partly how that topic wound up in the placeholder examples. I was just writing down potential topics as filler for the rest of the task information. When compiling the index, I'll go through the TCG as I make the list, to identify the appropriate topics.

Keegan renamed this task from Improve documentation related to Technical Collaboration to Catalogue and improve documentation related to Technical Collaboration.May 4 2017, 6:56 PM

The (start) list of pages is here: https://www.mediawiki.org/wiki/Technical_Collaboration_Guidance/Index

Being a wiki, I hope the link farm grows.

The assessment (step 2) has proved to be unnecessary at this time - it might be good to make a "use" column instead? - and I do not currently have any duplication to merge. Thus, the next step is improving existing pages if needed.