Answer the question
In order to leave comments, you need to log in
Where is the best place to keep service documentation?
Hey!
There is a service that is very cool and rapidly developing. According to it, there are many points that are best documented, so that later, as an example, do not spend a lot of time figuring out the principle of the algorithm for sorting and grouping data in a table, taking into account the fact that graphs should be displayed for some data if it satisfies the internal conditions is an example!
I really want to hear the practice from people who are engaged in internal documentation of functionality and other related things, as well as possibly covering functionality for external documentation.
Ideally, it will be if it is some kind of service, but stand-alone options are also considered.
Thank you!
Answer the question
In order to leave comments, you need to log in
For a small team (up to 5 people), you can try Atlassian's Confluence https://www.atlassian.com/software/confluence. The cloud version will be free. And so, any wiki-like system will do. The main thing in this process is not the software used, but the quality of work with the documentation. It must always be kept up to date.
if for myself, then everyone is satisfied with Googledox;
if for the team, then any wiki system
You didn't provide specific requirements. Without this, any advice is useless.
For example:
- features A, B, C are required.
- documentation will be used by H, K, L
- time to set up the process / possible cost - S.
PS Confluence - I do not recommend. This is a collaboration tool, not technical documentation!
https://cms.skeeks.com/community/blog/322-kak-pisa... - little experience with sphinx-doc
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question