How to write technical design docs

Technical design documents (aka tech design docs or tech specs) are a great way of creating detailed game plans for features or solutions to technical problems without implementing any code. They can ultimately end up saving your team a lot of time.

Here's a short post on how we do tech design docs at Mage.

Outline

• The importance of tech design docs
• When to create tech design docs
• Mage’s tech design doc template
• Purpose
• Background/Context
• Requirements
• Detailed design
• Implementation plan
• Tests
• Runbook