A few days ago, I was looking at Red Hat Summit 2020 and was surprised (well…not very surprised) there were no sessions dedicated to documenting open-source software.
Most open-source projects need documentation, or at least better documentation. Voila! Opportunity strikes. If I put together enough material, maybe I can help someone solve that problem. If my solutions have value, maybe I’ll get an opportunity to present at Summit or All Things Open in Raleigh next year.
So, on a whim and a prayer, I’ve set out to produce the most stupendous compendium of information ever amassed on the topic: documenting open-source software
But where to start?
Thirty years ago my older brother, who was ten years old at the time, was trying to get a report written on birds that he’d had three months to write, which was due the next day. We were out at our family cabin in Bolinas, and he was at the kitchen table close to tears, surrounded by binder paper and pencils and unopened books about birds, immobilized by the hugeness of the task ahead. Then my father sat down beside him put his arm around my brother’s shoulder, and said, “Bird by bird, buddy. Just take it bird by bird.
― Anne Lamott, Bird by Bird: Some Instructions on Writing and Life
So, which are my first birds?
I’ll start by writing about topics that are relevant to my work right now.