Documentation: A blueprint for effortless working!

Vishal Khode

Documenting any work done is often neglected & disregarded, whereas it's an asset which conveys the Overall Vision & Care of a project. The presence of documentation helps keep track of all aspects of an application and improves the quality of project.

Proper documentation helps in on-boarding new developers and helps in providing training to team on the ins-and-outs of the project.

Significance of Pre-release documentation :

Not only it lists the purpose and requirements of the products to be referred by stack holders(business, developers, designers) working on the products but also, acts as a proof of things to be carried out on a well planned time-line.

Significance of Post-release documentation :

Apart from being single source of truth, it is not only a user manual, a reference guide; documentation helps understanding whole purpose and functionality of product. It also eliminates the dependency and tribal knowledge.

In this session, we'll learn on:

- Why documentation is needed whereas code conveys everything ?
- Why documentation is hard for people & projects ?
- How writing documentation improves the design of our code ?
- How it helps in Code Reusability ?
- How it helps in saving time/money/efforts and How it's beneficial for Product Owner, Team members, End users etc.?

Learning Objectives
At the end of this session, attendees will be able to:

- Develop the proper documentation of the work that is done.
- Determine the importance of documenting technical knowledge.
- Summarise the approach/workflow for completing the complex task.

Target Audience
Project Managers, Product Owners who are looking to quickly get developers on board.

Prerequisites
None

*Session Materials*

When & Where

Time: 
Wednesday, 9 December, 2020 - 09:30 to 10:10
Room: 
Barcelona room