Tech Specification

adapted from how to write awesome tech specs by lyft engineering https //eng lyft com/awesome tech specs 86eea8e45bb9 summary 2 3 sentences describing the who/what/when/where/why of your entire project background the "why" and the existing context goals expected outcomes, both objective and subjective non goals what intentionally are you not doing? define and limit the scope plan the longest section of the spec, level of detail depending on audience describe the engineering approach, include architectural diagrams measuring impact what metrics will you use to measure whether this project met its intended goal? security, privacy, risks what are potential risks and how are you mitigating them? other considerations other approaches you considered but decided against and why milestones break the project out into intermediate milestones with estimated dates open questions unresolved questions you are still working through and need feedback on