FY23Q3 Hackathon Technical Writing retrospective
The Technical Writing team reviewed a number of documentation MRs for the GitLab Hackathon that ran from 2-9 August, 2022. This issue is to gather feedback and actions to improve the Technical Writing workflow and process for future hackathons.
Documentation MRs merged for the Hackathon (filters by Hackathon and documentation labels, 15.3 milestone):
Epics/issues that contributors worked on:
Handbook links where we talk about Hackathon contributions:
- Technical Writing Handbook page for Hackathons
- Hackathon Joining in guidelines.
- Contribute to GitLab links to Contributing to Documentation
How to add items
Create individual comments for every entry so that each item can have its own thread. Then, each thread will get an **Action: @mention**
for resolution tracking.
Start your comment with an H2 heading which will be used as its title, and add the appropriate icon ahead of it to indicate which category it falls under:
-
👍 What went well?## :thumbsup: What went well?
-
👎 What didn't go well?## :thumbsdown: What didn't go well?
-
💡 What can we improve?## :bulb: What can we improve?
-
❓ Items that are relevant for discussion but not a clear good or bad event to improve upon## :question: Items that are relevant for discussion but not a clear good or bad event to improve upon
-
💭 Items that are related but not required for closing the retro## :thought_balloon: Items that are related but not required for closing the retro
Edited by Kati Paizee