G
G
g00d2011-04-13 09:00:25
Work organization
g00d, 2011-04-13 09:00:25

Programming and documentation?

I have a question about the documentation in the project.
Many people write that there should, in theory, be documentation for developers and for users.
and both of these documentations stem from well-written code.
for developers, as I understand it, based on comments and code design, you can generate the same phpdoc, but as for user documentation, how is it?
What generally needs to be observed so that the project would be less dependent on a specific developer?
those. when changing the developer, a new person, without (or with minimal) help from the previous employee, was able to join the project?

Answer the question

In order to leave comments, you need to log in

3 answer(s)
L
Lev Lybin, 2011-04-13
@lybin

habrahabr.ru/qa/5968/ - for developers, eventually purchased Confluence

P
pratamishus, 2011-04-13
@pratamishus

As for user documentation, I always just wrote it myself. It's tedious, but necessary. Just use some basic screenshots and write in some word document.
As for changing the developer, just use generally accepted programming standards. Use OOP and system analysis techniques (UML, ClassDiagram, etc.). On the other hand, some say that there are no common standards and there is truth in this :). To do this, simply take the most popular book on programming in a particular language (for example, in PHP, the book by Luke Welling and Laura Thomson Web Development in PHP and MySQL - Luke Welling and Laura Thomson - PHP and MySQL Web Development) and adhere to their principles.
The rest of the new developer should figure it out himself. If the code is written well and structurally, then it will not be difficult for a normal developer to understand everything. Especially if you write documentation.

S
super, 2011-04-13
@super

The user documentation and the application interface should be one and the same, there is no reason to separate them.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question