Hi, I am writing more and more formal design documents for the systems we are building. I consistently get feedback that my design is incomplete and doesnโt read well. Specifically, I think the gap in my design documents is that a lot of context remains in my head and is not written down. Does anyone have tips / gotchas to watch out for / laundry lists they go through to ensure that their design documents are polished and complete ? Any trainings on this would be super helpful as well.
Use a template. Be sure to think about all the sub problems and come up with multiple design choices for each, with a proposed option for each of the sub problem.
Is there a template you recommend?
Are there any public examples of good design docs on GitHub or books worth learning this from?
Personal Finance
21h
2593
Calculated my NW and now i can't sleep
Software Engineering Career
5h
727
Meta E4 Offer
Tech Industry
6h
1130
I am starting to think Chinese interviewers currently fail non-Chinese candidates on purpose.
Tech Industry
9h
2376
The job market is absolutely brutal right now
Cars
Yesterday
1282
Do you use a luxury car as a daily?
I can help. Dm me
Username checks out ๐ ๐