2 ms·
I always write a design document first for anything larger than a few days' work. A few pages of prose is enough, written in Google Doc or Quip or whatever is t
by pavlov 7y ago
I always write a design document first for anything larger than a few days' work. A few pages of prose is enough, written in Google Doc or Quip or whatever is the comfortable sharing+commenting standard within the org.
Even if nobody else ends up attentively reading the document, it's valuable for myself as a point of reference after the work is done. It can be humbling to go back and read my own assumptions.
Usually some of the text can be transplanted into more permanent engineering documentation (Wiki or whatever), so it's also a good habit for documenting beyond just inline comments.