[{"_1":2,"_42":-5,"_43":-5},"loaderData",{"_3":4,"_10":11,"_40":-5,"_41":-5},"root",{"_5":-5,"_6":-5,"_7":-5,"_8":9},"user","shoppingCartId","toast","locale","en","routes/_store+/_readers+/email_author.$slug/route",{"_12":13,"_39":-5},"book",{"_14":15,"_16":17,"_18":19,"_20":21,"_22":23,"_24":25},"id","Z2lkOi8vbGVhbnB1Yi9TdG9yZTo6Qm9va1Byb2R1Y3QvNTIyNzQ","title","A Practical Guide to Writing a Software Technical Design Document","state","published","contactAuthorMethod","email","aboutText","

One of the key skills a senior software engineer should have is to write Technical Design Documents (TDD). However, not many companies actually teach their engineers how to write a good one. Many engineers have to learn by doing or observing how other engineers do it.

Many engineers can code perfectly but they don't really know where to start for TDD. Many of them question whether there is a need to write one. From my decades of engineering experience, TDD is a must and even a tool to help engineers achieve engineering excellence and create good systems with grounded principles.

This tiny book will guide you through the writing process of a Technical Design Doc. It also comes with a real-life example of a Technical Design Document.

Contents

Document Structure from a Bird’s-eye view
Diving Deep into Each Section
Design Review Process
Other Applications
Final Note
Appendix A (Example)

About Author

Grace Huang is an ex-founder with a successful exit. She writes about startups, entrepreneurship, investing, software and hardware engineering, manufacturing, and lifelong learning.

Check her Linkedin profile (https://www.linkedin.com/in/lghuang/) to learn more. Feel free to ask questions or drop a note on Twitter (https://twitter.com/iamgracehuang).

","authors",[26],{"_14":27,"_28":29,"_5":30},"Z2lkOi8vbGVhbnB1Yi9TdG9yZTo6UHJvZHVjdEF1dGhvci81NTIwOA","name","Grace Huang",{"_31":32},"avatar",{"_33":34,"_35":36,"_37":38},"url","https://d308did4coypzi.cloudfront.net/avatars/2711332/medium/CH7-25-2.JPG?1654664179","styleName","medium","exists",true,"currentUser","routes/_store+/_layout","routes/_store+/_readers+/_layout","actionData","errors"]

Email the author