MikeI love coding, but I really love writing requirements documents. It helps me organize my thoughts and understand projects better. It's much more effective for me than just reading docs that someone else wrote. #WebDev #SoftwareEngineering
sebastien@iMike
I work pretty much the same way. Writing helps structure my own understanding. I often rewrite documentation for myself, from my own perspective (taking notes or drawing diagrams), so the information "clicks" with my brain ;).
However, and I learned this the hard way in the field, what makes sense to me isn't necessarily logical for the end user. Relevant documentation shouldn't just be written; it needs to be architected.
I think it's crucial to ask the question: "who is going to read this and in what context?". There's nothing worse than struggling to find a piece of information. So, before even starting, getting the structure right from the get-go is essential.
Speaking of which, this is the very first doc I actually dared to publish... https://moustik.tngl.sh/pokedev/ (really not perfect)