I always believe that documentation is more important than the code itself.
Mohamed Zakarya
4 replies
Replies
Pradeepa Somasundaram@pradeepa_somasundaram
Code is fantastic for making your application do what it needs to do. But what happens when you add a new team member or begin to use new technology to achieve your objectives? To illustrate the flows within the application code base, you need some form of reference, and code is usually not very good at presenting this overview.
Proper documentation is required to describe the code, company lingo, and application flows.
There are three levels of documentation and what it does.
Macro-level: What exactly does that language mean, and how does the firm operate?
Meso level: How do our application's processes flow?
Micro-level: What is the purpose of this code and why is it present?
Share
I agree! Documentation provides a pathway from where to start and where it finishes. If you can document everything that is meant to be coded, it's just gonna make it just easier and more efficient. The documentation has to be exceptionally neat to follow through! That would just make the code itself much easier. My sole purpose is to document my work and send it to the devs. It clearly does wonders when it's done properly.
I agree no more
I agree.
Help future developers maintain your code
Can help you learn from your mistakes now so you won't repeat them