Howdy bot builders, tool tinkerers, researchers, and all other Wikimedia web API users –
We need your help! The MediaWiki Interfaces team is partnering with design (Sarai Sanchez <ssanc...@wikimedia.org>) to redesign the Wikimedia REST API Sandbox using Codex. If you have opinions about API documentation and what makes developer experiences good or bad, we would love to have you participate in an API sandbox discovery session! — What to expect — A ~45 minute video call session to ask questions about your Wikimedia API experience with a focus on pain points related to documentation. In addition to high level questions, we will ask you to perform a task or two to find information using the existing API docs, followed by reviewing mocks for the new experience to compare the experiences. If you’d like to participate, please either respond to this message or grab time directly on Sarai’s calendar <https://calendar.app.google/TAwmwy145SatRc5D7>. NOTE: Although the conversation will predominantly focus on building a better experience for the REST APIs, no experience with using them is necessary. In fact, we want some folks who have never used the REST APIs to see what the first use experience is like! — More Context — Earlier this year, we launched a limited release <https://www.mediawiki.org/wiki/MediaWiki_Interfaces_Team/Feature_Feedback/REST_Sandbox> of a new REST Sandbox built using SwaggerUI <https://test.wikipedia.org/wiki/Special:RestSandbox>. While this experience will be made available on all Wikimedia projects soon, we are also in the process of redesigning the experience from the ground up using Codex. The shift is motivated by better translation and internationalization support, and better compliance with open source standards <https://phabricator.wikimedia.org/T382086>. We also hope that by designing the documentation from the ground up, we can learn from a variety of best practices from APIs around the internet to create the best possible experience for Wikimedia developers. — Asynchronous feedback — We are still in an early phase of discovery, where live (and sometimes unexpected or meandering) conversations lead to the best learnings. We will provide an asynchronous feedback mechanism for the new experience as we get farther into the design refinement process, where users like you will be able to review screenshots and provide feedback on your own time. Even if you don’t have time to talk to us now, keep an eye out for future calls for feedback on this topic! In the meantime, we do have a few other options for asynchronous feedback: - For feedback on the existing, SwaggerUI REST sandbox, please review and respond to the open feedback prompts <https://www.mediawiki.org/wiki/MediaWiki_Interfaces_Team/Feature_Feedback/REST_Sandbox#Open_feedback_prompts>or start a new conversation on the discussion page. - For broader API feedback, feel free to respond to the developer discovery prompts <https://www.mediawiki.org/wiki/MediaWiki_Interfaces_Team/Developer_Feedback/Wikimedia_Web_APIs> we have about Wikimedia Web APIs or raise a new topic on the discussion page. — What’s next? — We are currently in the design stage for the redesign, with a plan to start implementation in a near future quarter. Because we have the opportunity to completely customize the experience, we would love to get feedback early and often from the community to make sure it fits your needs and creates a delightful experience for all Wikimedia developers! Please feel free to reach out with any questions, comments, or concerns you might have. We look forward to hearing from you, and can’t wait to shape the future of the Wikimedia APIs together! Thanks, Halley & Sarai *Halley Coplin* (she/her) Sr. Product Manager, MediaWiki Interfaces Wikimedia Foundation <https://wikimediafoundation.org/>
_______________________________________________ Wikitech-l mailing list -- wikitech-l@lists.wikimedia.org To unsubscribe send an email to wikitech-l-le...@lists.wikimedia.org https://lists.wikimedia.org/postorius/lists/wikitech-l.lists.wikimedia.org/
