S
S
Sanes2015-05-04 16:06:24
Documentation
Sanes, 2015-05-04 16:06:24

Where can I see examples of documenting the development of the site?

Tell me what tools to use and what to pay attention to. Now there is a task to create a relatively large and complex web project and I want to document it. Purely for himself, the customer does not pay for this, and he probably does not need it.

Answer the question

In order to leave comments, you need to log in

4 answer(s)
D
Dimonchik, 2015-05-05
@dimonchik2013

readthedocs.org

E
Edward Tibet, 2015-09-14
@eduardtibet

You didn't mention the most important thing: WHY do you need to write documentation?
Possible options:
1. "For show" - to hand over to the customer.
2. To reduce the cost of ownership - for example, so that new / external developers do not ask "how it works" and do not distract.
3. To make life easier for yourself - for example, so that a new version can be made based on the old one and nothing is forgotten over time.
4. More options ....
These are the MOST important questions. Answer them - then you can think further :)

V
Valentine, 2015-05-14
@Tpona

In my opinion, the most correct approach is the meta-markup of comments from which the help system is then formed.
We use Doxygen .
All you need to do is to correctly format the comments to the code.

S
semenovsanek, 2017-02-24
@semenovsanek

https://cms.skeeks.com/community/blog/322-kak-pisa... - little experience with sphinx-doc

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question