This task is an umbrella project to capture multiple workstreams that are part of the Tech Docs team's Q4 focus on building a culture of documentation.
Goals
This work includes multiple mini-objectives around two primary goals:
- Goal 1: Support new technical documentation contributors
- Goal 2: Grow awareness of tech docs resources and opportunities for engagement with tech docs community
Objectives
Improve basic technical writing guidance and resources for new contributors to Wikimedia tech docs.
- Gather info:
- [done] Interview Outreachy doc project mentors and 2 new contributors to learn about their experiences getting started with tech docs.
- [done] Review docs created during WMA Hackathon and look for recurring issues.
- [done] T392613 Review the Content Audit checklist.
- [done] T391271 Single-source tech docs guidance from doc metrics project into Docs Toolkit, where appropriate.
- [done] T345293 Refresh the Tutorial template.
Revise and apply guidance for technical documentation "good first tasks"
- [concluded to be infeasible after research] T391606 Clarify what makes a good first doc task and update guidelines for filing tasks.
- [done] T391611 Review tools in Toolhub and create good first docs tasks for 5 tools that meet criteria (tool must be maintained, active, welcome contributions, not experimental…)
- Stretch: Reach out to 2 developer teams to offer tech writer support for defining and creating good first doc tasks relevant to their team's docs.
- Stretch: Coordinate a fun event for Friends of the Docs to improve/refine existing docs tasks into good first tasks, and/or create new good first tasks.
Raise awareness about tech docs resources and encourage community engagement within WMF.
- [done] Present about docs outreach activities at Developer Experience all hands.
- [deprioritized] Revive "doc tip of the week" for the months of May & June, and experiment with posting the tips on Slack and IRC.
Work in progress is tracked in the sub-tasks.