DEV Community

Nathan Englert
Nathan Englert

Posted on

How much technical documentation do you write?

Technical documentation, written in the right way, can be a very useful tool for:

  • Onboarding
  • Troubleshooting
  • Handing a project off to another team (perhaps an operations team?)
  • Figuring out what the heck a piece of code does after coming back to it a year later
  • Etc., etc.

How much do you write? What tools do you use? Do you follow a certain template or methodology? Sound off below! 👇

Top comments (2)

Collapse
 
scottishross profile image
Ross Henderson

Not enough.

Collapse
 
kyleljohnson profile image
Kyle Johnson

I believe the code should be your documentation. If during your code reviews you stress maintainability and readability then that should be enough.