For me the problem with the documentation si too keep it updated. I mean, sometimes we're coding and when we're arriving to the last part of our tasks is hard to remember all the things that we made, well, we can put an extra complication here, imagine this a subtask of an story that are assigned for three developers, this is getting complicated right? how we will organise all the documentation, and what is the best way to document it?
When we're learning software development nobody is showing to us methodologies for document well. This is probably one of the big mistakes, because we don't have the habit.
For me the best documentation is the code and the tests that we're applying in the code. An idea that I had in my mind is to apply an extra step in TDD (is my way to work) and writing the documentation before starts to code but the problem here is when we're changing our "roadmap" after writing or updating the documentation.
In the end document the code is not an easy work and not all the people have the skills to do it.
Nice idea!
For me the problem with the documentation si too keep it updated. I mean, sometimes we're coding and when we're arriving to the last part of our tasks is hard to remember all the things that we made, well, we can put an extra complication here, imagine this a subtask of an story that are assigned for three developers, this is getting complicated right? how we will organise all the documentation, and what is the best way to document it?
When we're learning software development nobody is showing to us methodologies for document well. This is probably one of the big mistakes, because we don't have the habit.
For me the best documentation is the code and the tests that we're applying in the code. An idea that I had in my mind is to apply an extra step in TDD (is my way to work) and writing the documentation before starts to code but the problem here is when we're changing our "roadmap" after writing or updating the documentation.
In the end document the code is not an easy work and not all the people have the skills to do it.
Keeping docs up to date is exactly the problem we've solving. Our tool will automatically update or let you know when your documentation needs review.
Agree that a lack of methodologies is a hindrance - we actually have a template library to get you started and to suggest what to include.