3 ms·
I sometimes like to write the documentation for the module, to varying degrees of completeness, before I write any code. I find that for infrastructure modules
by jerf 15y ago
I sometimes like to write the documentation for the module, to varying degrees of completeness, before I write any code. I find that for infrastructure modules it really helps to make sure that you're writing an API that serves the API user, instead of serving the API designer, because you discover right away if you're writing an idiotic API.
If you want to smear a thin patina of faddishness over it, you could declare the documentation is a form of TDD, except that we're testing something that automated testing simply can't, which is the effective usability of the API from a human point of view. But then, I'm not too worried about yon thin patina of faddishness. Sometimes it's the right tool for the job, often it isn't.
- gabebw 15y agoTake this as faddishness or not, but this sounds like README-driven development from Tom Preston-Werner: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html http://tom.preston-werner.com/2010/08/23/readme-driven-devel...
- jerf 15y agoSimilar, but I shield myself from "DDD" turning into waterfall by doing this on modules, not projects. It's sort of like how capitalism thrives by embedding a lot of top-down control economies ("corporations") within the larger framework of freedom; a top-level bottom-up "Agile" framework can benefit from the occasional use of a top-down design process embedded within it, and you aren't obligated to angst about the internal contradictions, because there really aren't any.