R
R
RaptorVRN2017-06-25 20:22:32
API
RaptorVRN, 2017-06-25 20:22:32

What are the services for documentation in software development?

Good afternoon.
We write services in a small team, we are tired of maintaining documentation in the docks.
Tell me an adequate service for maintaining project documentation so that you can edit it with pens.
At the output, I want to get something similar:
https://vk.com/dev/methods
https://docs.python.org/3/c-api/exceptions.html#
www.php.su/functions/?abs
Today we are leaning towards the banal wiki on RedMine

Answer the question

In order to leave comments, you need to log in

7 answer(s)
G
GTRxShock, 2017-06-26
@GTRxShock

swagger.io + https://github.com/Rebilly/ReDoc

L
Lumore, 2017-06-25
@Lumore

gitbook

E
entermix, 2017-06-26
@entermix

https://apidocjs.com/
https://readthedocs.org/
https://getgrav.org/
https://www.gitbook.com/
https://daux.io/
https://wiki.js. org/

L
lukoie, 2017-06-26
@lukoie

wikidpad

P
Philipp, 2017-06-27
@zoonman

raml.org

M
motomac, 2017-06-29
@motomac

https://apiary.io/

E
Edward Tibet, 2017-07-01
@eduardtibet

First, answer the following questions:
1. Do you need a cloud service or does it need to be deployed on premises?
2. Do you need a free service?
3. You need to document _only_ the API, or else you need to make different diagrams, write coherent text, etc.
4. Do you need to generate documentation from the code automatically?
From your text of the question, I see that you cannot yet formulate the requirements for the system. And this is one of the clear signs of a very big mistake when choosing a system. And by the way, please note that all the participants in the thread above offered options without even asking what exactly you need!

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question