Thanks for capturing this. We will work on the two subtasks first and those will give us enough material to do a first draft of documentation for the tool.

More information from Nick in email:

//
https://meta.wikimedia.org/wiki/Recommendation_API
If I'm guessing correctly... that is going to be the main hub page, for the software that has been worked on for the last few quarters. I was trying to find more info, or specifically, links to add to/from that page.

Poking around, it looks like [some/all] of these pages are related, and

1. should be linked in the SeeAlso section at that page (as a completionist linkdump, until further organization needs to be done),
2. and possibly these pages should also link to it (as the main hub).

• https://meta.wikimedia.org/wiki/Research:Increasing_article_coverage
• https://meta.wikimedia.org/wiki/Research:Increasing_article_coverage/Tool
• https://www.mediawiki.org/wiki/Wikimedia_Research/Goals ("recommend[...]" in Q1/2/3)
• https://blog.wikimedia.org/2016/04/27/article-recommendation-system/
• https://wikitech.wikimedia.org/wiki/Nova_Resource:Recommendation-api
• (plus 1 link at https://wikitech.wikimedia.org/wiki/Research which should possibly be changed to the Recommendation_API hub page?)

I couldn't find anything else at metawiki, mediawikiwiki, or wikitech.
//

I've added the links to https://meta.wikimedia.org/wiki/Recommendation_API#See_also

I've also split out the bullet list into individual sections.

@schana the focus here should be to document GapFinder. In this process, we should also improve the documentation for the technology behind it (Recommendation API) but that's only part of the work for documentation. Please take a look at some product documentations such as https://www.mediawiki.org/wiki/Content_translation to get a better sense of how this can be done.

I'm creating a product page here: https://www.mediawiki.org/wiki/User:NSchaaf_(WMF)/Gapfinder

The page is now here: https://www.mediawiki.org/wiki/GapFinder

@leila Can you review?

@schana this is a good start but a lot more should be added to the page. Here are some comments on the documentation (I shared these with you on on 2017-05-04, listing them here for documentation purposes;).

• Please think about who the audience you're writing for is and what you want them to do when they land on this page. This will help you add more information to the page or break down certain kind of information.
• Expand introduction about the tool
• Expand on how the tool works. What's the technology behind it, in lay terms, how do we know it works, etc. (other than the link to the research paper which is hard to comprehend for the lay audience).
• Under workboards: encourage people to submit tasks to the boards. Also, give a description on how the two workboards are different. They should go to which one for what?

Nick who originally had filed the task reviewed the page and here are his suggestions:

• It says "GapFinder is a set of tools to provide personalized recommendations of tasks to editors." - Needs an explanation of what "personalized" entails, and whether/how it can be overridden by editors.

• Possibly, merge the content from https://meta.wikimedia.org/wiki/Research:Increasing_article_coverage/Tool into that page, and turn the old page into a redirect. (Fewer pages, is almost always better - easier to update, easier to ctrl-f, less duplication, etc)

• Add a few screenshots of a walkthrough, demonstrating how it should be used, and things to keep in mind, e.g. "Translators should be fluent in both languages, so that they can determine the nuances in the original article."

• If Gapfinder bugs & feature-requests should be filed as part of the phabricator project Recommendation-API, then
  • Add this template, anywhere on the page: {{ptag|recommendation-api}}
  • Add a link to mw:Gapfinder, at https://phabricator.wikimedia.org/project/profile/2128/

• If Gapfinder bugs and feature-requests should not be filed as part of the phabricator project, then explain somewhere on the wikipage where users should file those.

@leila I've addressed the comments from T133997#3241938. Care to review? https://www.mediawiki.org/wiki/GapFinder

@schana thanks. My schedule is packed between now and the end of next week given that it's the end of the quarter. I will be able to read and provide more detailed comments in the week of July 10. In the mean time: I had a quick look and I didn't find "Expand on how the tool works. What's the technology behind it, ..." or "Add a few screenshots of a walkthrough, demonstrating how it should be used, and things to keep in mind ..." addressed, or have you documented these and I've missed them?

In T133997#3386782, @leila wrote:

@schana thanks. My schedule is packed between now and the end of next week given that it's the end of the quarter. I will be able to read and provide more detailed comments in the week of July 10. In the mean time: I had a quick look and I didn't find "Expand on how the tool works. What's the technology behind it, ..." or "Add a few screenshots of a walkthrough, demonstrating how it should be used, and things to keep in mind ..." addressed, or have you documented these and I've missed them?

There are walkthroughs in the respective Gap Type pages. The Translation type has a How does it work? section, but the Missing Section type is still waiting on T160594 to inform what will go in its section.