,
4 tweets,
1 min read
Read on Twitter
So we started running an experiment on my team a couple of months ago where design docs are checked into a repo and reviewed as a PR instead of done in a word doc and stored on a sharepoint or wiki. This was inspired by @github process, and I have to say I love it.
Its really easy to see what comments were made and track that they are addressed, and which docs are a work in progress vs approved. If its in master it is approved, otherwise still in progress.
Its the same tool chain developers use all day to write and review code, so writing and reviewing docs doesn't feel like a huge context switch.
And now its super easy to update and track the history of the doc over time. If a new person finds the doc has diverged from what we actually have when ramping up, they can just submit a PR.
