Keep the documentation up to date throughout the project
Article#: 00087
Date: 2024-03-01
Author: Radim
At the beginning of a project, we usually have a clear idea of how the project will be fully documented.
Complete documentation makes it easier to set project goals, coordinate teamwork, make adjustments during the project, train new members and has many other advantages.
Unfortunately, disciplined documentation is increasingly neglected in practice over the course of a project.
There are various reasons for this.
The documentation is often not located in one central place.
Some team members may not even know what is contained in the documentation.
There may not be enough time to update the documentation when solutions are being adjusted in practice.
And then the documentation becomes outdated, incomplete, and sometimes even misleading.
Such documentation can even later lead team members down completely wrong paths that have nothing to do with the actual solution.
Therefore, it is extremely important to create a central repository for all project documentation.
This repository should be easily accessible to all team members and clearly defined as to where to store documents and how to update them.
Other team members should be automatically informed about updates.
It is essential to appoint responsible persons for the accuracy of the documents.
Furthermore, it is important to establish checkpoints during the project where the status of the documentation is reviewed and necessary updates are made.
Original ideas and definitions that have been modified or replaced should not be deleted but marked as obsolete.
The longer the project lasts, the more challenging it becomes to maintain the original documentation up to date.
However, the investment of time and effort into maintaining documentation pays off multiple times over.
Consistent maintenance of up-to-date documentation contributes to the success of the project and minimizes the risk of confusion and errors.
© Radim-Automation, 2020–2025. All rights reserved.
Sharing of this article is permitted with proper attribution (link to the original page).
Related previous articles:
- PLC network diagram
- Version control system
- Talk to operators
- Clear signals
- Design considerations for effective HMIS
- Documentation issues
- Visual modeling
- Variable names
- Abbreviations
- Modular software architecture
- Hardware concept
- A good concept = Complete set of suitable solutions
- Design machines with a focus on user's abilities and needs
- Project leader
- Why do automation projects fail?
- Collect all the requirements and sort them!
- Use a usefull styleguide!
- Write down your best practices and processes!
- Prepare a good project plan and keep it up to date!
- Do you really want to start with this?
- Store email messages in the project folder!
- Do the right things and do them right!
- Define test scenarios and test cases continuously!
- Write a project diary!
- Keep the answers to the question "Why"
- Introduce the terminology and standardize it!
- Ask questions!
- Communication skills are extremely important
- Don't leave a work package half-finished!
- Success is not a matter of coincidence
- Choose the right tool!
- Don't neglect and don't skip any step!
- Transparency and reliability
- From an idea to a consistent system
Related next articles:
- Maintain order in the program code
- Keep everything you need together
- High Performance HMI
- An irreplaceable employee
- HMI - Have a consistent style
- Hidden dangers during commissioning
- The false illusion of rapid progress
Comment#: 00001
Date: 2024-04-09
User: Radim
Proper storage of information is crucial for efficient work and easy and quick access at a later date.
A good archiving structure and discipline helps to maintain clarity and structure in the working environment, which contributes to the productivity and success of the project as a whole.
It is therefore important to pay sufficient attention to where and how information is stored and to follow appropriate archiving and organization procedures.