Intro
I remember starting developing my own tools, like some python scripts like Mazeltov and stop with the issues. So this time, for Log Helper I have created a Design Doc, following what Techled suggested – btw, he is very funny.
Design Doc
There are many good templates for Design Doc, and Angela Zung is able to describe here very well some details about it – though I might disagree on the comedy part though.
I think this model here is very to the point, but seems almost like a read.me kind of thing.
This reference here, from Klariti.com, is the one I’d think it’s the complete solution. Too big for a small script as Log Helper though.
Remember that: The design doc is written as part of the development of the software design
REFs
inline