The importance of documentation
I’ve noticed a common trend in projects that were executed well. The trend is not connected to the actual implementation of a project, it was directly influenced by the quality and consistency of documentation. You work hard to find the best solution, uncovering insights, really trying to make a difference in the experience but all of this work doesn’t really amount too much with out adequate and consistent documentation. A big mistake is to think that documentation exclusively covers the end result. Instead its value lays in being incremental and should be held at high priority throughout the entire process.
There are three main aspects that contribute to making documentation valuable:
Accessibility. Imagine looking at a data heavy table without any formatting, not knowing where to focus and how to translate the data. When you add elements associated to the data; statuses, trend lines, a photo to accompany names, the comprehension improves dramatically. (Fyi, I have a fascination with data tables). This logic can be easily applied to documentation. Make it accessible by focusing on details that facilitate its legibility and comprehension. Breaking down areas with different statuses, tags, data tables, images, check lists, external links, ect. Whatever artefacts and information you have to track the progression, use it. These details go a long way and will improve the relationship and interaction your stakeholders and colleagues have with the project.
Progression. If you document the beginning and the end, there’s a sea of information missing to connect the dots. Stay consistent with the supportive documentation of a projects progress. This will help the team be able to spot blockers and arrive to a stronger solution.
Collaborative. Bring people in. Make them part of the process of documenting the different phases. Ask them to fill in areas and leve their point of view. Send the documentation to the group, sharing is caring. They will be able to follow and feel appreciated for their contribution.
I have identified three main phases that need to be documented and can be applied to many different areas: product design, communication, ux research, product management ect.
Request. Identify the core needs and pain points before jumping to the solution. This allows for others to get involved and for a controlled planning and proioritization.
Project. Have a source of truth that is the primary collection of all that covers the project. Main information like, motivations, main objectives, who is responsible for what, road map and phases can be stored here. Keep it updated! As the project evolves go back here to fill it up and remind you of why you are doing this in the first place.
Results. Make sure there is an overview that collects and reassumes the outcomes. Especially if the outcomes are located in external formats, use this as a container to sum up the activity. Will be a great point to share with others.
Above are the three main areas to document, but that doesn’t mean you have to stop there. Dig deeper if needed to better organize the process of the project. Best practice to document all phases such as decisions, feedback, meetings, co-designs, interviews, ect. Whatever you have to support your work and push it forward make sure it has the proper visibility. Show it off!
Pay attention to trends in your work process, and create documenting templates around them. This will help you and your team integrate, improve and scale project documentation. Get creative, documentation doesn’t have to be boring!
