Response to https://twitter.com/sarahmei/status/862479305590284288
Whenever we’re going to make a medium or big change (feature, refactor, etc.) we’re always encouraged to create a design doc before doing actual coding:
- Create a design doc.
- Have people review it and comment on it (we use Google docs of course 😅).
- Then finally start coding and sending the change lists (pull requests) for review.
The content and format of the docs changes a lot between people, but typically includes: issue/feature/task at hand, screenshots of mocks if it’s a GUI change, possible solutions/designs, high and low level descriptions and justification of the chosen one, code snippets or pseudocode, and sometimes diagrams.