Documentation of software developed

Asked

Viewed 205 times

1

The file must contain:

  • Explanation of the BD with Model ER
  • Explanation of the Interface,
  • Explanation of property files
  • Use Case Diagram Creation (or other such that exemplifies all software progress from user open to close)

Last and most important I think

  • Creation of the class diagram

I know that the creation of the class diagram should be the first thing when I started the project but it was not realized.

Questions

  1. The topics I mentioned above are right? Should I remove/change/add some?
  2. As for the class diagram there is some program that does the reverse of passing from classes (Java code) to the creation of UML rectangles, or in case there is no good example to guide me?

IDE is the netbeans

  • 1

    For your first question, the answers are too based on opinions for the Stackoverflow format. For your second question, I think the indication of tools is out of scope (in English stackoverflow at least is off-topic).

  • 2

    I will follow to see other opinions about the framework of your question. As for tools, there is. Ex: http://plugins.netbeans.org/plugin/1801/netbeans-uml. For documentation, in general (because it is highly debatable) write only the documentation that someone is interested in reading now (installation manual and system usage manual if it is not very intuitive, for example). Or write down everything you’ve listed if you’re paying for it :D

  • I find it a very questionable question, I suggest we take the goal

No answers

Browser other questions tagged

You are not signed in. Login or sign up in order to post.