Answer the question
In order to leave comments, you need to log in
How to document an existing solution?
Good afternoon.
At the moment there is a system (DB + Web interface + ios \ android application). Because the project is slowly growing, and the developers don’t remember what and where they changed, + the problem of introducing new employees to the staff, it was decided to document the entire solution. What tools are best for this?
Are there any methodologies for such reverse documentation?
Answer the question
In order to leave comments, you need to log in
As an option, raise the internal wiki. From experience, I’ll tell you personally, as a programmer, it was most convenient to work with wiki.
To understand what kind of solution you need, you need to ask yourself the following questions:
1. Is the documentation supposed to be taken out?
2. In what output formats do you want to deliver documentation? Is signet supposed (as a class)?
3. Is multi-level documentation expected (ie, for example, several modules for client A, several for client B, etc.)?
4. Do I need to document the API (manually or automatically)?
5. Who will support this entire economy?
6. What is the volume (approximately) now and what will be the volume after a year?
7. Is it necessary to keep the versioning of all this stuff?
I have more questions, but that's enough for now :)
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question