Hej hej, as you may remember from previous[1] posts[2], we (Alex[3], Bryan[4], Sarah[5], Tricia[6], and me[7]) are working on a developer portal for technical documentation[8] and updating key technical documents. The goal is to make it easier for everyone to find the help and information you need about the technical side of MediaWiki software and Wikimedia projects and to improve the overall quality and discoverability of technical documentation.
I'm going to share what has happened over the last months (also see the general schedule[9]). Regarding the technical stack, we decided on a platform[10]. Its work- in-progress codebase is in Gerrit[11] and there might be a demo server soon[12]. This is the technical scaffold; actual content will be added when we get closer to launching in a few months (see the corresponding task graph[13] for work to sort out before launching). We defined core audiences[14] and had nine user tests completed[15] so far. The feedback helped iterate on the Developer Portal content layout draft prototype[16] (which evolved from a unified to a multipage approach). We are also in the process of reviewing and improving many key technical documentation pages (which will get linked from the developer portal). These updates and accuracy checks are based on a review checklist[17]. The checklist may also be helpful for anyone else interested in good technical documentation. For planning documentation review work, we use a Phabricator workboard[18]; you can also find the list of key pages on the project wiki page[19]. To get involved, sign up[20] to participate in user testing for the developer portal. For questions and feedback, leave us a comment on the project talk page[21]. All these efforts are part of the goal to have discoverable docs and paths to entry[22]. Cheers, andre [1] https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/message/YIIXKY455DCOFIF63BARD2BJEGIC7YF3/ [2] https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/message/XBNIH2Q3WJG5ECZXVBKGNCIB6GJ4KHX4/ [3] https://meta.wikimedia.org/wiki/User:APaskulin_(WMF) [4] https://meta.wikimedia.org/wiki/User:BDavis_(WMF) [5] https://meta.wikimedia.org/wiki/User:SRodlund_(WMF) [6] https://meta.wikimedia.org/wiki/User:TBurmeister_(WMF) [7] https://meta.wikimedia.org/wiki/User:AKlapper_(WMF) [8] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal [9] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Timeline [10] https://phabricator.wikimedia.org/T287175 [11] https://gerrit.wikimedia.org/g/wikimedia/developer-portal/ [12] https://phabricator.wikimedia.org/T297800 [13] https://phabricator.wikimedia.org/T261510 [14] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Core_audiences [15] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal/Call_for_feedback_and_testing [16] https://apaskulin.github.io/wmf-dev-portal-draft/ [17] https://www.mediawiki.org/wiki/Documentation/Review_template [18] https://phabricator.wikimedia.org/project/profile/5409/ [19] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Key_landing_pages [20] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal/Call_for_feedback_and_testing#We_could_use_your_help! [21] https://www.mediawiki.org/wiki/Talk:Developer_Advocacy/Developer_Portal [22] https://www.mediawiki.org/wiki/Wikimedia_Technology/Annual_Plans/ERF_OKR:_Tech_Community_Building -- Andre Klapper (he/him) | Bugwrangler / Developer Advocate https://blogs.gnome.org/aklapper/
_______________________________________________ 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/
