4 ms·
Ask HN: How do you handle writing huge amounts of required documentation?
Howdy HN,
I've recently been put in charge of a heavily delayed project at work with, to put it mildly, a lot of documentation needing to be written. Now I like writing docs, which already makes me a rarity among devs, but this is a different animal from Diataxis - this is the whole nine yards of IEEE 1558 conformant documentation. If you've ever seen the acronyms SPMP, SQAP, SVVP, SDD, ..., you know what I'm dealing with here.
We have a decent amount of documentation written already, but there are large gaps, and more pressingly none of it has been put into the proper formats required by the IEEE standards. To keep my sanity on this project I've spun up a Jira board to help me keep track of all the different sections, subsections, etc going on here, and to let me asynchronously ping my Verifier and Approver each time I finish drafting a new section, so that we can try to deal with this thing in human sized chunks.
Now I turn to you. Were you ever in a situation like this? What did you do?