10. Documentation skills

In this post, I am going to write how documentation skills will help us improve our development process.

We are all starting our career from programmer level which straightway starts writing the code and don’t spend time to write or document what we did. Due to lack of documenting our work, we need to spend lot of time to understand and maintenance the code which we normally don’t realize.

We used to write the code but not document about our work. We should document our work and it will help us definitely.

Everyone raise next question is that where is time for documenting our work? This is really good question. We should allocate some time for documenting our work. This time allocation should be in the project schedule and in the SOW (Statement Of Work). Otherwise we never get the time to document our work.

Next question is what to document?

Documenting our work not limited to

1. What overall system does with short description which help other developers
2. How the system interconnected to other systems if it is
3. Write comments on the coding that what the method or system does on the specific section.
4. Write Application Support Manual (ASM) and Application Support Process (ASP) based on your organization structures which everyone adopts on your organization.
5. Prepared the generic template which says what need to document whenever the project or allocated task has been completed.
6. Included UML diagrams on your each and every project or task.

We no need to spend lot of time or documenting unnecessary stuff which we don't need really. However, we need to document the necessary things and which help for support and our future  development.

Can we start documenting our work? Yes we can…………..