This Is Why Most Software Engineers Don’t Write Documentation

More than skill set, it’s actually due to a lack of good documentation tools

Emanuel Marques
Better Programming

screen showing a list of files under the heading “documentation”
Photo by Sigmund on Unsplash

No matter whether you work in a small startup or a big corporate company, the odds are that when it comes to good, valuable documentation of your services or projects, there will be a huge gap and need for it.

This can impact multiple parts of an organization, from discussion forums to decide the best path to a goal to the onboarding of new colleagues that need to ramp up their knowledge about how your systems are structured and communicate with each other.

But if everyone feels this problem right on their skin, why on earth does this still happen these days?

Why Is Documentation So Important?

Meetings

If you have ever been involved in discussions of a new, upcoming project that the company needs to figure out how to fit into its current codebase, you know the number of ideas, suggestions, and solutions that are analyzed during those meetings. This number increases exponentially depending on how many people participate in the meeting.

Each proposal for a solution usually comes with its own pros and cons discussed in the meetings.

Create an account to read the full story.

The author made this story available to Medium members only.
If you’re new to Medium, create a new account to read this story on us.

Or, continue in mobile web

Already have an account? Sign in

Responses (3)

What are your thoughts?