• Home|
  • Blogs|
  • Documentation - When? How? Why?

Documentation - When? How? Why?

Do you remember before marriage you said something to your wife as fun, she documented it in her mind, and she referred it many times that on that day you have promised me about........😁😂😇😍🤡 Yes, you are right..! Documentation is important part of every business too.🤠

When to document?

Documents should be created when a new work, process or procedure is implemented

When there is a change to an existing project, process or procedure

Periodically all company documents should be reviewed to encourage process improvement, to reduce data redundancy, and to evaluate methodology

How documentation should look like?

Ease in structure (use index and sections properly)

Should contain language easy to understand for concerned stackholders

Zero errors in spelling, grammar, & formatting

Implement with 3 C's (correct, complete, current)

It is must to add Reference Tagging (links)

Pictures and attachments wherever needed

Easily repeatable/understandable

Document as you go, not after all phases done

More is more (not less is more)

Why good documentation?

Knowledge & Learning Preservation - ensures the effective transfer of knowledge and learning, and facilitates communication of information

Increases Quality & Consistency of operations

Standardized reference that ensures Absolute Accountability

We at GrassDew IT Solutions not only provide various software services but also maintain proper documentation of software solutions as delivery. It helps client's technical team or other vendors to understand what software GrassDew delivered. It in turns helps all to be on same page in integrated environments and future maintenance.

GrassDew has four main business streams – Consulting Services, Software Solutions, Security Services and Knowledge Services. Our primary focus is on various software development and maintenance services.

To know more about our services, email us at shekhar.pawar@grassdew.com