DEV Community

Discussion on: 💻 Documentation as code

Collapse
andrebell profile image
Andre Alexander Bell

I personally think, that documentation is not the last step. If you really document your reasoning to why you solve a task at hand the way you did, then documenting is the key thing to do first.

If you think this to the edge you indeed end with “literate programming”, where you compile documentation into code and then compile that code into the product. This was mentioned in the comments before, but at least I drop a link:

en.m.wikipedia.org/wiki/Literate_p...

Collapse
adamcoster profile image
Adam Coster Author

Agreed! I saw somebody refer to this general idea as "Executable Documentation", and another as "Documentation-Driven Development." In that case I've been practicing "Document-Driven Tools-Driven Test-Driven Development" (docs first, then appropriate external tooling, then tests, then code).