Change Details

The following resources contain information and ideas about approaching our technical content and assessing it. They also contain a TON of other info. To keep this project in scope, do not get distracted by all the content in these resources that is about what our docs lack, or what developers want from the docs themselves. Focus on these three questions: - What strategies or tools have people used, considered or suggested to **identify sets of related docs** or **divide up the content space**? - What strategies or tools have people used, considered or suggested to **assess the state of a set of related docs, and identify work needed to improve them**? To review: [x] https://commons.wikimedia.org/w/index.php?title=File:Small_wiki_toolkits_brainstorming_session_at_Indic_Wikimania_Hackathon_2022.pdf [x] https://meta.wikimedia.org/wiki/Content_Partnerships_Hub/Software [x] Wikimedia technical conference 2019 docs session notes and summary: T234634 [x] [[ https://docs.google.com/document/d/1iIwseuuNVN631Z8196iNVlFqwxaj9IrFbfd0NxLL_mo/edit#heading=h.kb2yrj6xz9rx | Google doc ]] summarizing WMF and WMDE staff feedback in initial investigations preceding dev portal project [x] https://www.mediawiki.org/wiki/Developer_Wishlist/2017/Documentation [x] [[ https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2020#Developer_Documentation | Developer satisfaction survey 2020 ]] [x] [[ https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2021/Categories/Documentation | Developer satisfaction survey 2021 ]] [ ] [[ https://www.mediawiki.org/wiki/Wikimedia_technical_documentation:_Friends_of_the_Docs#Past_meetings | Friends of the Docs and Doc Working Group meeting notes ]] [ ] Analysis of our docs from a past Outreachy project: - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy/Outreach_strategies - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy/Final_report [ ] https://etherpad.wikimedia.org/p/Developers_and_MediaWiki session notes 2017 [ ] Toolforge 2 annual surveys 2015 - https://meta.wikimedia.org/wiki/Research:Annual_Toolforge_Survey/2015 - https://meta.wikimedia.org/wiki/Research:Annual_Toolforge_Survey/2016 - https://www.mediawiki.org/wiki/Developer_Wishlist/2017/Documentation [ ] review the [[ https://etherpad.wikimedia.org/p/wmhack21-documentation-q-and-a | questions ppl asked at Docs Q&A at 2021 hackathon ]] [ ] Developer wishlist 2017 item around Documentation special interest group: T156301 [ ] https://www.mediawiki.org/wiki/User:Xephyr826/Recruiting_Technical_Writers [ ] https://www.mediawiki.org/wiki/User:Waldyrious/Docs (only review the content on this page, any links that are still relevant are included as items in the following list) [ ] currently-abandoned process for using phabricator for doc tasks and prioritization: https://www.mediawiki.org/wiki/Documentation/Technical_documentation_prioritization [ ] a thread with many good ideas to consider and extract, i.e. T149372#2834421 [ ] answers about documentation under "Questions for Newcomers" from 2017 hackathon: https://www.mediawiki.org/wiki/Wikimedia_Hackathon_2017/Lessons_Learned#Questions_for_Newcomers [ ] Another previous iteration of a "how can we do tech docs" project - https://www.mediawiki.org/wiki/WMF_Projects/Technical_Documentation - https://www.mediawiki.org/wiki/User:Zakgreant/Tech_Docs_Plan_(2011-01/P6M) - https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan [ ] https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons [ ] https://www.mediawiki.org/wiki/MediaWiki_Documentation_Day_2017 [ ] https://www.mediawiki.org/wiki/Write_the_Docs_San_Francisco_Meetup_May_2017 [ ] [[ https://drive.google.com/drive/folders/0B1JeNXQndW5oYllSb05SM2lfdVE?resourcekey=0-sJcK569rsyh3meH4sZ45VQ&usp=sharing | Cloud services annual surveys ]](restricted link) (Note that these surveys are usually more representative of staff developer opinions than community developers; their response rates are historically higher in the Toolforge surveys. So, just skim these.) [ ] Hackathon 2022 doc discussion notes: https://www.mediawiki.org/wiki/Documentation/Technical_documentation_community_and_outreach_programs/Hackathon_2022_docs_discussions [ ] KR1 strategy: "collections" ([[ https://docs.google.com/document/d/1yHk_0AFj4vtwTk570T71lfDOTCdGr09z1pkH0h1pf_k/edit#bookmark=id.d3m3y9sq3hqc | restricted Google doc ]]) [ ] KR1 review process and template for accuracy criteria https://www.mediawiki.org/wiki/Documentation/Review_template [ ] [[ https://docs.google.com/document/d/1osSGgHzx02erQ66ysVW72sJ3m8x-JuQowmTVHjl9JVQ/edit?usp=sharing | Outputs from my review of the Localisation / Localization collection ]]. I can't say I would recommend this as a task-generation process, but there could be good elements in it for collection assessment. But also, I was pretty new to this role when I did this so just keep that in mind ;-)

The following resources contain information and ideas about approaching our technical content and assessing it. They also contain a TON of other info. To keep this project in scope, do not get distracted by all the content in these resources that is about what our docs lack, or what developers want from the docs themselves. Focus on these three questions: - What strategies or tools have people used, considered or suggested to **identify sets of related docs** or **divide up the content space**? - What strategies or tools have people used, considered or suggested to **assess the state of a set of related docs, and identify work needed to improve them**? To review: [x] https://commons.wikimedia.org/w/index.php?title=File:Small_wiki_toolkits_brainstorming_session_at_Indic_Wikimania_Hackathon_2022.pdf [x] https://meta.wikimedia.org/wiki/Content_Partnerships_Hub/Software [x] Wikimedia technical conference 2019 docs session notes and summary: T234634 [x] [[ https://docs.google.com/document/d/1iIwseuuNVN631Z8196iNVlFqwxaj9IrFbfd0NxLL_mo/edit#heading=h.kb2yrj6xz9rx | Google doc ]] summarizing WMF and WMDE staff feedback in initial investigations preceding dev portal project [x] https://www.mediawiki.org/wiki/Developer_Wishlist/2017/Documentation [x] [[ https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2020#Developer_Documentation | Developer satisfaction survey 2020 ]] [x] [[ https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2021/Categories/Documentation | Developer satisfaction survey 2021 ]] [x] [[ https://www.mediawiki.org/wiki/Wikimedia_technical_documentation:_Friends_of_the_Docs#Past_meetings | Friends of the Docs and Doc Working Group meeting notes ]] [ ] Analysis of our docs from a past Outreachy project: - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy/Outreach_strategies - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy/Final_report [x] https://etherpad.wikimedia.org/p/Developers_and_MediaWiki session notes 2017 [ ] Toolforge 2 annual surveys 2015 - https://meta.wikimedia.org/wiki/Research:Annual_Toolforge_Survey/2015 - https://meta.wikimedia.org/wiki/Research:Annual_Toolforge_Survey/2016 - https://www.mediawiki.org/wiki/Developer_Wishlist/2017/Documentation [ ] review the [[ https://etherpad.wikimedia.org/p/wmhack21-documentation-q-and-a | questions ppl asked at Docs Q&A at 2021 hackathon ]] [ ] Developer wishlist 2017 item around Documentation special interest group: T156301 [ ] https://www.mediawiki.org/wiki/User:Xephyr826/Recruiting_Technical_Writers [ ] https://www.mediawiki.org/wiki/User:Waldyrious/Docs (only review the content on this page, any links that are still relevant are included as items in the following list) [ ] currently-abandoned process for using phabricator for doc tasks and prioritization: https://www.mediawiki.org/wiki/Documentation/Technical_documentation_prioritization [ ] a thread with many good ideas to consider and extract, i.e. T149372#2834421 [x] answers about documentation under "Questions for Newcomers" from 2017 hackathon: https://www.mediawiki.org/wiki/Wikimedia_Hackathon_2017/Lessons_Learned#Questions_for_Newcomers [ ] Another previous iteration of a "how can we do tech docs" project - https://www.mediawiki.org/wiki/WMF_Projects/Technical_Documentation - https://www.mediawiki.org/wiki/User:Zakgreant/Tech_Docs_Plan_(2011-01/P6M) - https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan [x] https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons [ ] https://www.mediawiki.org/wiki/MediaWiki_Documentation_Day_2017 [ ] https://www.mediawiki.org/wiki/Write_the_Docs_San_Francisco_Meetup_May_2017 [ ] [[ https://drive.google.com/drive/folders/0B1JeNXQndW5oYllSb05SM2lfdVE?resourcekey=0-sJcK569rsyh3meH4sZ45VQ&usp=sharing | Cloud services annual surveys ]](restricted link) (Note that these surveys are usually more representative of staff developer opinions than community developers; their response rates are historically higher in the Toolforge surveys. So, just skim these.) [ ] Hackathon 2022 doc discussion notes: https://www.mediawiki.org/wiki/Documentation/Technical_documentation_community_and_outreach_programs/Hackathon_2022_docs_discussions [ ] KR1 strategy: "collections" ([[ https://docs.google.com/document/d/1yHk_0AFj4vtwTk570T71lfDOTCdGr09z1pkH0h1pf_k/edit#bookmark=id.d3m3y9sq3hqc | restricted Google doc ]]) [ ] KR1 review process and template for accuracy criteria https://www.mediawiki.org/wiki/Documentation/Review_template [ ] [[ https://docs.google.com/document/d/1osSGgHzx02erQ66ysVW72sJ3m8x-JuQowmTVHjl9JVQ/edit?usp=sharing | Outputs from my review of the Localisation / Localization collection ]]. I can't say I would recommend this as a task-generation process, but there could be good elements in it for collection assessment. But also, I was pretty new to this role when I did this so just keep that in mind ;-)

The following resources contain information and ideas about approaching our technical content and assessing it. They also contain a TON of other info. To keep this project in scope, do not get distracted by all the content in these resources that is about what our docs lack, or what developers want from the docs themselves. Focus on these three questions: - What strategies or tools have people used, considered or suggested to **identify sets of related docs** or **divide up the content space**? - What strategies or tools have people used, considered or suggested to **assess the state of a set of related docs, and identify work needed to improve them**? To review: [x] https://commons.wikimedia.org/w/index.php?title=File:Small_wiki_toolkits_brainstorming_session_at_Indic_Wikimania_Hackathon_2022.pdf [x] https://meta.wikimedia.org/wiki/Content_Partnerships_Hub/Software [x] Wikimedia technical conference 2019 docs session notes and summary: T234634 [x] [[ https://docs.google.com/document/d/1iIwseuuNVN631Z8196iNVlFqwxaj9IrFbfd0NxLL_mo/edit#heading=h.kb2yrj6xz9rx | Google doc ]] summarizing WMF and WMDE staff feedback in initial investigations preceding dev portal project [x] https://www.mediawiki.org/wiki/Developer_Wishlist/2017/Documentation [x] [[ https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2020#Developer_Documentation | Developer satisfaction survey 2020 ]] [x] [[ https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2021/Categories/Documentation | Developer satisfaction survey 2021 ]] [ x] [[ https://www.mediawiki.org/wiki/Wikimedia_technical_documentation:_Friends_of_the_Docs#Past_meetings | Friends of the Docs and Doc Working Group meeting notes ]] [ ] Analysis of our docs from a past Outreachy project: - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy/Outreach_strategies - https://www.mediawiki.org/wiki/User:Contraexemplo/Outreachy/Final_report [ x] https://etherpad.wikimedia.org/p/Developers_and_MediaWiki session notes 2017 [ ] Toolforge 2 annual surveys 2015 - https://meta.wikimedia.org/wiki/Research:Annual_Toolforge_Survey/2015 - https://meta.wikimedia.org/wiki/Research:Annual_Toolforge_Survey/2016 - https://www.mediawiki.org/wiki/Developer_Wishlist/2017/Documentation [ ] review the [[ https://etherpad.wikimedia.org/p/wmhack21-documentation-q-and-a | questions ppl asked at Docs Q&A at 2021 hackathon ]] [ ] Developer wishlist 2017 item around Documentation special interest group: T156301 [ ] https://www.mediawiki.org/wiki/User:Xephyr826/Recruiting_Technical_Writers [ ] https://www.mediawiki.org/wiki/User:Waldyrious/Docs (only review the content on this page, any links that are still relevant are included as items in the following list) [ ] currently-abandoned process for using phabricator for doc tasks and prioritization: https://www.mediawiki.org/wiki/Documentation/Technical_documentation_prioritization [ ] a thread with many good ideas to consider and extract, i.e. T149372#2834421 [ x] answers about documentation under "Questions for Newcomers" from 2017 hackathon: https://www.mediawiki.org/wiki/Wikimedia_Hackathon_2017/Lessons_Learned#Questions_for_Newcomers [ ] Another previous iteration of a "how can we do tech docs" project - https://www.mediawiki.org/wiki/WMF_Projects/Technical_Documentation - https://www.mediawiki.org/wiki/User:Zakgreant/Tech_Docs_Plan_(2011-01/P6M) - https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan [ x] https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons [ ] https://www.mediawiki.org/wiki/MediaWiki_Documentation_Day_2017 [ ] https://www.mediawiki.org/wiki/Write_the_Docs_San_Francisco_Meetup_May_2017 [ ] [[ https://drive.google.com/drive/folders/0B1JeNXQndW5oYllSb05SM2lfdVE?resourcekey=0-sJcK569rsyh3meH4sZ45VQ&usp=sharing | Cloud services annual surveys ]](restricted link) (Note that these surveys are usually more representative of staff developer opinions than community developers; their response rates are historically higher in the Toolforge surveys. So, just skim these.) [ ] Hackathon 2022 doc discussion notes: https://www.mediawiki.org/wiki/Documentation/Technical_documentation_community_and_outreach_programs/Hackathon_2022_docs_discussions [ ] KR1 strategy: "collections" ([[ https://docs.google.com/document/d/1yHk_0AFj4vtwTk570T71lfDOTCdGr09z1pkH0h1pf_k/edit#bookmark=id.d3m3y9sq3hqc | restricted Google doc ]]) [ ] KR1 review process and template for accuracy criteria https://www.mediawiki.org/wiki/Documentation/Review_template [ ] [[ https://docs.google.com/document/d/1osSGgHzx02erQ66ysVW72sJ3m8x-JuQowmTVHjl9JVQ/edit?usp=sharing | Outputs from my review of the Localisation / Localization collection ]]. I can't say I would recommend this as a task-generation process, but there could be good elements in it for collection assessment. But also, I was pretty new to this role when I did this so just keep that in mind ;-)