跳到主要內容

發表文章

目前顯示的是 8月, 2018的文章

How to write a good software design doc

Refer to:  https://medium.freecodecamp.org/how-to-write-a-good-software-design-document-66fcf019569c Notes: Why? make sure the right work gets done. 1. think through the design 2. gather feedback from others What to Include in a design doc? 1. Title and People the author(s), the reviewer(s), the date the document was last updated. 2. Overview  A high level summary  3 paragraphs max 3. Goals and Non-Goals  describe the user-driven impact of your project  specify how to measure success using metrics (bonus points if you can link to a dashboard that tracks those metrics) 4. Milestones listing out important milestones, but not yet attaching them to specific dates   5. Current Solution   A   user   story   is a great way to frame this. current implementation how users interact with this system how data flow through it 6.  Proposed Solution /  Technical Architecture 7.  Alterna...