Member-only story
Why should you always write design documentation?
This article will review the importance of writing design documentation before writing a single line of code.
Just like a pirate, a software engineer needs to resist the urge to start a treasure hunt without a map. Design conversations and design documents served as maps to guide us into building the ultimate product, which is defacto the treasure.
So, let's start with the design conversations.
Design conversations
Design conversations are, in my opinion, the most critical conversions software engineers need to have before starting writing any lines of code.
Design conversations are conversations during which we (software engineers) transform an abstract concept of a new feature, an enhancement, or a solution to a problem into a concrete solution through exchanges of ideas and discussion.
But on top of those conversations, I think we should always create a document that summarizes the solution we aim to implement, with a step-by-step execution plan. In other words, the design documentation is just like your very own treasure map.
In the beginning, writing design documentation seemed to be counterproductive. I was spending a significant amount of fixing my grammar and conjugation errors and…
