Project documentation for each part of the project: technical / user / test documentation

How should a web application look, work and what does it want to achieve? At the beginning, only the manager has all this in his head, and it is impossible for the project to depend on one person who is the bearer of the idea.
In addition, if the human factor comes into play and the project is long-lasting, we don't have to remember everything. Project documentation should be a part of every project – the description of user stories, the description of the UX design, testing and technical documentation.


Project management, documentation, project maintenance, software development, software testing

Software development is a very specific part and there is no doubt about the importance of project documentation – for testers, developers and managers. Keeping and maintaining documentation may seem time-consuming, but as a result, it saves time not only for the manager, but also for the development team.

Nothing specific, just the ability to write factually and concisely

generic: high level abstract best practice, metalevel category (e.g. manage architectures)

Application domain:
Medicine/Healthcare, Education (Technology enhanced learning), Data science (analysis & visualisation), Software engineering

Main phase:
Generic: Requirements/Exploration, Generic: Design/Plan, Development: Implementation/Code/Build, Development: Testing

Related literature:

In which projects do/did you use this practice?

Data Analyst, Project Manager, Researcher

3–5 years of experiences
Masaryk University

1. How do ​you rate the potential benefit for your projects? 5
2. How often are you using that practice? 4
3. What is the effort to introduce the practice in your project upfront? 3
4. What is the effort to apply the best practice in your project daily basis? 4

Questions 1, 3 and 4 (1 = Low, 5 = High)
Question 2 (1 = Never, 5 = Always)

You are running an old browser version. We recommend updating your browser to its latest version.

More info