How to keep current documentation of the current state of functionality in an Agile environment

Question

Agile should be easy to document. In a flexible world, it is very likely that the initial requirement changes very quickly based on end-user input or design changes. The new requirement is captured in the form of a new user story, which again can be very short and may change in the near future. In this case, it becomes difficult to manage / maintain standardized behavior documentation for any functionality so that any future links can be referenced. In the IT world, people sometimes tend to move fast, and it becomes difficult to understand how something was designed a year ago and why. If there are any information specialists who would like to share with this, that would be great. Thanks you

Answer 1

Compose user documentation in software: intuitive user interface in software. Good software is self-explanatory. If necessary, add additional documentation to the help system (tips, help menu, etc.).

From the technical side, store the documentation in clear code and code documents, express functionality in executable tests (from unit tests to acceptance tests). Put redundant information on the wiki that can be easily updated. Automate building construction / publication of the documentation site and follow the DRY principle: one should be documented only once and referenced from there.

Key points:

• Document well what needs to be documented (think of a typical user).
• Do not document the obvious.
• Good software is self-explanatory.
• Do not repeat yourself.
• Automatically generate documentation from source code.
• Save specifications in the form of executable tests.
• Quickly delete obsolete documents.

Answer 2

It depends on what you need. There are no predefined rules. Agile promote easy documentation for requirements. However, it is recommended that you document the piece of software that you create (user story) according to your specific needs.

That is why I like the concept of "definition done."

In your definition, you can indicate that you need good written technical documentation about the functional structure that you create, including why you choose both ...

It is for you.

The strength of flexibility lies in the fact that you can significantly reduce the amount of waste.