DEV Community

Discussion on: 💻 Documentation as code

manvillej profile image
Jeff Manville

why write two documents when one will do? between the code, tests, comments, and naming conventions; documentation serves no purpose other than checking a box.

adamcoster profile image
Adam Coster Author

All of those things are forms of documentation. The question is who needs to know what about the project, and then ensuring that all stake holders have access to sufficient documentation that is likely to be accurate. There's definitely no reason to add a form of documentation that isn't needed by anyone!