DEV Community 👩‍💻👨‍💻

Discussion on: 3 Essential Components of Great Documentation

Collapse
 
rmarpozo profile image
Rubén Martín Pozo

In my opinion, one of the main problems of documentation is how fast it gets outdated. In the past I tried things like Specification by example and "Living documentation" but it tends to be too expensive (time and money) to be effectively used in real projects.

Right now, we're using Guru as our documentation platform. It keeps the documentation small (very important to prevent it from getting old pretty quick) and reminds authors to check their articles every now and them to see if they are up to date. I recommend to give it a try. We're pretty happy with this solution.

Collapse
 
eli profile image
Eli Bierman Author

Thanks for sharing your experience! I've in the past tried the Literate Programming technique, but also found it very difficult to maintain.

Guru seems like a really interesting way of doing it; I'll check it out. My first impression is that it seems like it focuses on the experience of writing and using the documentation, which I like.