Doc week - proposal
Kicking off this idea with a proposal! Welcome your thoughts/feedback
Have a free week away from day-to-day activities to accomplish much needed tasks that are just never the most urgent, but still important to do.
Document/update anything and everything that will help us or our community to better do our work:
- Technical specifications
- Dev docs
- Onboarding guides
- Any critical information sitting with one person (i.e. a single points of failure)
Part of the exercise could also be reviewing that we have the right information architecture in place.
End of year seems like a good time as we wind down for the holiday season - but - don’t want to get in the way of development deadlines. How about the w/c 2nd December? Or we could easily move this into early 2020 if that feels like it will give more buffer around v1 launch/other priorities.
How it works
- In advance of Doc Week - all teams post a list of docs or projects they want to work on (including info about the task and what skills/help are needed, so people can get involved).
- Teams wrap up any urgent work in the week prior, and clear schedules during Doc Week.
- We tackle the list of documentation needs together, everyone’s free to work on anything on the list.
- Debrief at end of the week - teams can present back on what they accomplished.
- Architecture and where we store docs - what will be the structure? E.g. revive the Wiki, use Google Docs, GitHub, or other. Probably needs a lot of consideration/consultation.
- Who will be accountable for maintaining docs in future?
- How do we spread knowledge to avoid single points of failure?