search

rodekruis / IBF-system

Tools required to trigger, manage and execute the Red Cross Early Action Protocols for natural disasters.
https://ibf.510.global
Apache License 2.0
12 stars 15 forks source link

What do we want to accomplish with the Documentation Track? #1672

Open diderikvw opened 1 month ago

diderikvw commented 1 month ago

What do we want to accomplish with the Documentation Track in the IBF System Roadmap?

This Spike is to align as IBF System Team how we can optimally use the deliverables and time in this track to our advantage as a team: not only to "check off" that "documentation is created as promised", but also (1) going a bit more into detail which documentation we want to create/update and why (value), how to do this together, to improve team learning and knowledge sharing (process), and if and how we will keep the documentation up-to-date once created (outdated documentation is worse than no documentation).

I suggest we organize a 1h team session.

@gulfaraz AFAIU you were in the lead for creating the "documentation track" in the Roadmap. So, perhaps it makes sense you start off giving a "show&tell" of what you had in mind. Then we have a conversation, while taking notes. Then someone "processes" the outcome by (a.o.) updating/adding items to the PB, and seeing with Blaise when/how we want to pick stuff up.

Related items:

1585

1516

1577

See some documentation ideas based on recent bugs here.

Glossary is in scope for this work.

diderikvw commented 1 month ago

@jannisvisser @Piotrk39 @arsforza Feel free to "braindump" anything here already.