There are a plethora of acronyms when it comes to software development. KISS, DRY, SOLID… and so on and so forth. But, when it comes to documenting or commenting your code, there is no simple catchphrase.
Why is that?
Documentation should be as important to a developer as all other facets of development
In this article, I’ll argue why documenting your code will lead to becoming a better developer, and will contribute to being a great team member.
Ain’t nobody got time for that
The main reason code goes undocumented is because of time.
When developing a feature that needs to be completed within a certain time frame, rarely do we have a moment to stop everything and focus on documenting our code.
Apart from designing and writing the code itself, we also need to undergo code reviews, automation tests, and add unit tests (to name a few things). Documentation is pretty much left out of the equation.
It is the least thought about detail that can make the most difference in the future.
No matter what you are developing, chances are that some day you or one of your colleagues will have to revisit it. When that day comes, you will not remember so vividly what you wrote and why.
And if you do remember, there may be some edge cases or specific uses which may not be clearly apparent. The obvious solution is documentation.
Taking that extra time to write a proper description of what you worked on will save huge amounts of time in the future.
Next time someone wants to understand what happens inside your code, all you have to do is point them to the documentation. It will save time for you, since you won’t need to explain things, and it will save time for them, since they won’t be dependent on you.
And after all, when you, as a developer, need to understand something about a certain aspect of coding, what do you do?
? You go to the documentation ?
Good code does not need documentation
Yeah, I know, I know… well written code, that is concise and well thought out, does not need to be documented. It reads like a story.
While that may be so, it does not forego the need for documentation, and here is why:
- We are all too familiar with the robustness of code that comprises a feature. Looking at one section of code, may not make it clear there are other sections that are deeply linked to it.
- Every service you create has a unique API to it. Writing how to use that API requires documentation that can be read outside of the code. You do not want to inflate the class itself with details about how to use the API.
- Coworkers who work in different departments (who may not be developers) may want to understand what you did and how it works.
- Just the act itself may cause you to look differently at the code you wrote. Explaining what your code does will cause you to assess the validity of it and to maybe consider changing things if they do not meet your expectations.
- For posterity’s sake
How to write good documentation
Good documentation is like a good block of code. Short, simple, and easy to understand. Here are a few guidelines you can follow:
- Understand who the documentation is aimed at. Is it only for developers? Is there a broader audience? Understanding this will save you time, since you will know up front how much to elaborate in your explanations.
- Write a short, but descriptive background explaining the main points of what you built. This will help readers understand the purpose of the feature and ascertain its relevance to what they want to know.
- List and describe the main perspectives of your feature, making sure to point out any dependencies that exist with other features.
- Make sure there is a timestamp, to tell readers the validity of the documentation. Also, if you are using certain libraries, be sure to include their versions as well.
- Be generous with your coding examples, detailing how to properly use the feature you wrote and showcase the expected results.
In MDN’s documentation, you can clearly see that each page starts with a brief explanation about the subject.
Then, it proceeds to detail the use cases and methods. Finally, it shows which browsers are compatible with the feature and gives links to relevant material.
Django’s documentation is very robust. No matter your coding level, they start you off with an overview and tutorials.
Then, they go through each subject, detailing it meticulously, giving short and concise code snippets that demonstrate what needs to be done
I hope I have managed to stress the importance of documentation and have given you some pointers on how to start documenting your code. If you have an idea for an acronym for documentation, feel free to do so in the comments below.
Maybe KID — Keep It Documented?
If you liked this article, clap away so that others can enjoy it as well! ???