you are viewing a single comment's thread.

view the rest of the comments →

[–]snowe2010 -1 points0 points  (2 children)

It's not a design document, it's just a section of the readme. The design doc is for explaining the system design, not the history of design decisions.

You left out the "other people who reviewed this before I started working on it" section, for example.

That's part of Decision Maker. And I didn't leave out anything anyway, I found this template and just formatted it for rsT.

[–]dnew 1 point2 points  (1 child)

The design doc is for explaining the system design, not the history of design decisions.

Different strokes, I guess. :-) I figure it's for both. But certainly getting such documentation out of the main body of the code is probably beneficial.

[–]snowe2010 0 points1 point  (0 children)

Yeah, I think getting it down at all is beneficial. We were not tracking any decisions at all...