Skip to main content

Posts

Showing posts from March, 2017

Describing the System

I can hear the snoring already.  Documentation?  The topic is documentation? As I mentioned in the welcome the goal of this blog is to shine a light on some things that we pretend are something they are not.  Nothing is more of this nature than the documentation of a software product. Nobody would disagree that documentation can be useful. It helps communicate intent to the person who we cannot directly educate. However, there several problems with documentation: There is a cost of creating it. If wrong it has more negative value than positive. It often calcifies our thinking.  Spending hours on something creates an investment in the idea.  So...our objectives are to make sure that: There is really a need.  The cost of creating the documentation should be merited because future team members (or perhaps even current team members) will be more efficient with this knowledge (or avoid screwing up something they didn't understand) The documentation ...