I
I
Ivan2011-04-18 09:39:16
Documentation
Ivan, 2011-04-18 09:39:16

Software documentation?

Dear community, I am currently working on one project and it needs to be fully documented. In this regard, the following question arose: what should this documentation look like and what should be included in it? In my understanding the following should be present:

  1. comments in code
  2. uml diagrams
  3. description of the database structure
  4. description of the interfaces for the interaction of modules with each other

And Maybe there are some ready-made software tools for describing all this in a single center, something more specialized and convenient than MS-office?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
S
sainnr, 2011-04-18
@sainnr

In general terms, about what documentation is needed and in what case, it was here .
If you want to follow documentation standards (GOST, ISO), then look here .

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question