DEV Community

Cover image for Update Your Documentation Yearly
Scofield Idehen
Scofield Idehen

Posted on

Update Your Documentation Yearly

We got the MikroTik 951ui 2hnd board for a project.

From setup, we encountered lots of problems, and it was nearly impossible to know why, as the documentation offered little or no solutions as to why.

We ran blindly and are still running blindly; so many steps are not covered.

It felt exhausting checking out videos on YouTube and forums, reading blogs and articles, and using AI.

While we are still stuck and unable to resolve the issue, I boldly say that documentation should never be a single story.

It should encompass every scenario and build on the users' daily experience.

No documentation should be the same after 2 years.
Softwares evolve, and so must the documentation.

Learning must be progressive, or we will build far ahead of our time to catch up.

I do hope after this experience. I can reach out to MikroTik to help build a community around their product and see from the inside what are the critical issues in real-time.

Top comments (1)

Collapse
 
kurealnum profile image
Oscar

Only a year? Jeez, I'm an overachiever! In all seriousness, I would love to see more projects update their documentation super frequently. As a user/developer, I prefer to have a little bit too much documentation instead of not enough (and as you mentioned, documentation that builds on the users' experience).