Does Project Documentation Really Matters?

Creating software to solve problems is indeed a beautiful thing, and it involves patience and determination.

However, documenting the project, and writing unit tests as well as penetration tests to assert the workflow of the said project are stressful/difficult paths. Without those paths, you are an island to your project especially the docs because no one can easily be attracted to your work.

Documentation plays a pivotal role in ensuring that your project thrives and remains accessible to others. Do not underestimate the documentation of your project, and always update it if there are code changes, the same rule also applies to writing test cases.

We have different documentation language tools you can learn, and one good thing is that they are easy to master if you take an interest in mastering any of them. Examples are Markdown (md), reStructuredText (rst), etc. For me, I used either of the two. However, if I am writing complex documentation of a project, then Sphinx which uses rst is my best shot. Try and pick one and learn if you haven't. Most recruiters and employees do add documentation to their job description as a skill you should possess before they can hire you. So, why don't you start today?

As software engineers, we don't just design, create infrastructure, and write a bunch of codes, we should also cultivate the habit of writing. It matters a lot because through writing you can express the man's innermost heart.

Please free to ask me questions regarding the documentation of your project.

You can get me on any of these links:
LinkedIn, GitHub, Twitter or Stackoverflow

Software #Engineering #softwareengineers #python #pythonsoftwareengineers #fullstack #frontend #Django