Page MenuHomePhabricator

Get early feedback on AQS user docs prototype site
Closed, ResolvedPublic

Description

Share the prototype of the AQS user docs site, and collect early feedback.

Note: This site is a prototype intended to collect early feedback on the structure of the docs. All the content is placeholder content and is not final.

  • Collect feedback from the team
  • Collect user feedback (lightweight process)
  • Iterate on information architecture and style guide

Prerequisite: T365040: Set up prototype site for AQS user docs on Toolforge

Event Timeline

The prototype site is now ready for early feedback at its temporary home at https://wm-analytics-api.toolforge.org/! We are looking for feedback about the structure of the pages: the organization of the information and the sidebar navigation. We're still developing the site, and the structure may change, but we wanted to take this chance to get early feedback. Feel free to leave feedback as comments on this task.

Note that this is an early prototype, so all content is placeholder content and is not final. For more information about our thinking behind the information architecture and what information belongs in each section, see T363016.

Really happy to see this prototype. Very cool!

I appreciate the dark mode option so much!
Also really appreciate how this process is forcing us to answer open questions and define terms in ways we have not had the hard requirement for / place to put it yet 😍

Structure of page feedback:

  • The sidebar structure that people are used to when navigating docs is music to my eyes.
  • Looking forward to the examples section where, like Santi said in slack, we can show developers and product managers what is possible to do with the APIs. 🌟
  • Access policy: could this include getting an API Key / Token? Currently the routing does not require this, so this is more of an open question once we start versioning.
  • I will be curious to learn how to users understand the various headings when given specific tasks to do when user testing is done.

A couple questions not related to structure of the page:

  1. I'm sure I missed this at an earlier stage, but the name of the API has been changed in the docs from Analytics Query Service (AQS) to Wikimedia Analytics API. I like it! Can you tell me more about the naming process? I'm wonder what, if anything, that means for code repos.
  2. Will there be a homepage / landing page like codex? If so, it would be a great opportunity to highlight some of the data research notebooks, data visualization opportunities and show how we use it for Wikistats.

Thanks for this awesome feedback, @VirginiaPoundstone!

Access policy: could this include getting an API Key / Token? Currently the routing does not require this, so this is more of an open question once we start versioning.

We can add a note that the API supports OAuth. It's not something developers will expect with this type of API since OAuth is more for "Log in with Wikimedia"-type use cases, and practically it's a lot of overhead for developers to implement if it's not required. But it won't hurt to mention it. We may need to link to Meta instead considering the state of the API Portal.

I'm sure I missed this at an earlier stage, but the name of the API has been changed in the docs from Analytics Query Service (AQS) to Wikimedia Analytics API. I like it! Can you tell me more about the naming process? I'm wonder what, if anything, that means for code repos.

Thanks for asking about this! This is one of the things I wanted to talk to you about once you had a chance to look through the prototype. In the docs for AQS 1.0, the overall API was called "Wikimedia REST API" and the individual APIs were named things like "Pageviews API". Looking at the existing docs, it seemed like "Analytics Query Service" was more of an internal name for the underlying service more than a user-facing term. The idea was to continue this pattern using user-friendly terms, similar to "Wikimedia REST API" and names like "Pageviews API". But we wanted to talk to you and get your thoughts! I think "Wikimedia Analytics Query Service API" is too long and too jargony to work for users. We liked "Wikimedia Analytics API" for its consistency with https://analytics.wikimedia.org/, but we also considered "Wikimedia Metrics API". Let us know what you think! Happy to schedule some time to chat through this if that's easier. I don't think this would need to have any impact on code repos or maintainer docs.

Will there be a homepage / landing page like codex? If so, it would be a great opportunity to highlight some of the data research notebooks, data visualization opportunities and show how we use it for Wikistats.

Yes! Love the idea of highlighting Wikistats. I'll look around, but let me know if you know of any other cool tools or visualizations we could highlight.

Access Policy: makes sense not to add Oauth info now. Let's link to https://www.mediawiki.org/wiki/API:Etiquette for now (sigh)

"Wikimedia Analytics API" is good. We will want to make sure it is clearly AKA AQS to decrease confusion.

Since landing page with highlights is a backlog item, I'll keep it as a seed plant for later.

Thank you @apaskulin and sorry for delay in my response.