3
I’m in the middle of producing a web system, actually almost at the end... The point is that no documentation was developed for the system, it was all being developed "directly", based on another old system that the company had.
Since I never did documentation, I did a lot of research on the Internet, but I couldn’t find anything very solid about it. Much is said about use case diagrams, relational model, description of classes and objects and etc.
I wanted to know if there is any model that I could follow as an example, because I don’t want to end up doing something that is missing things or with unnecessary things.
How do I know what should really be in the documentation and what you don’t need?
I also found places talking about various types of documentation, the project, the system, the code, the database, the user, anyway... I couldn’t quite understand how it should be done, if someone could give me a light would be great.
I don’t know anything formal about it. To be perfectly honest, if you’ve never done it and you don’t even know what it’s about, you’re probably not the right person for it. I imagine that most people have learned as I have, seeing what exists and copying the basic ideas, adapting to their need. I have my doubts whether it is possible to answer this question without being broad, or even whether it is part of the programming. Although programmers do this intuitively, this is a work of communication and not programming. Check this out: http://answall.com/q/94146/101
– Maniero
What is the purpose of your documentation? What is the target audience? There are several different things you can call "documentation".
– bfavaretto
@bfavaretto the client said he wants the documentation to register the system and to make future changes.
– Raylan Soares
@bigown I’m really not the right person for this, but we have no options rs
– Raylan Soares
And in what language is your system, and on what platform it runs?
– bfavaretto
It is a web system in PHP @bfavaretto
– Raylan Soares