So, let’s all be on the same page first ー
badto have no documentation
goodto have documentation
- And, it’s
flippin’ amazingto have documentation which is thorough, organised, collaborative, well-written, well-structured, well-articulated and more-well-full-of-productivity-fairy-dust-qualities.
In this post, I will share a template for writing technical specs.
The template outlines lower-level details of the engineering work needed for a feature, service or a small project.
In 2015-17, I worked with the amazing team at Super.jobs (tinder for jobs). It was the most amazing time I’ve had working. At Super, we came up with this template for writing tech specs.
I have made a few adjustments over the years while retaining the core document structure. Here is the template -
#TODO Attach a example tech spec.