Technical Writing Best Practices for Engineers

Chapter 4 of 9 · 3 practices · 2 min · 3-question quiz

Write design docs people can review

A design doc is a tool for getting feedback before code exists. Write it so reviewers can find the decision and challenge it quickly.

Keep reading

7 more chapters, 23 more practices, free with an account.

You have read the open chapters of the Technical Writing Best Practices for Engineers guide. Every chapter it covers is listed above, and an account opens the rest: each practice with why it matters, how to apply it and an example, with your progress saved as you tick them off. Early access is open: sign up and your account is active shortly after.

Everything here is free to learn from. A few things, like adding a roadmap, keeping a cheat sheet or asking Tauseef a question, use credits. You get 15 when you join, your first roadmap is free, and if you are learning seriously and run out, you can ask for more. Credits only make sure the platform goes to people who are actually learning.