Answer the question
In order to leave comments, you need to log in
Documentation system for the project under development
Good day!
We develop a web project, the project develops and expands, it took a documentation system for developers to not keep everything in my head, because it becomes difficult.
What would you advise us to solve this problem?
Thanks in advance to everyone for suggestions. Thank you!
PS not necessarily a third-party service, even better not, because the project is commercial.
We use linux and mercurial.
PSS We need simple but convenient documentation. We do not need to describe the entire project, especially since then maintaining the huge documentation up to date is an additional time-cost.. It is necessary, for example, to mark that we add such and such a class to the input will be such and such, such and such, it can gradually endure some nuances, for example, one of the developers will have a question, the answer to which is not clearly visible in the code - right away to the knowledge base, assuming that someone else might have one, describe plugin configs, etc., so that newly arrived programmers say something like: “Learn to google!”, Referring to our knowledge base :)
Answer the question
In order to leave comments, you need to log in
Media wikis are heavy... Is the project too big? Are you sure you need a separate system for documentation? After all, you can use the built-in wiki in all sorts of different bug trackers / PM systems ...
There is not a bad tracking system Trac , it can be used as a wiki and as a task tracker.
I use sphinx for such purposes. And in general as a knowledge storage system. You can export to latex, which is sometimes convenient.
I support the previous commenter.
I will add only the url to download the media wiki - http://www.mediawiki.org/wiki/Download
The most difficult step, after you force yourself to keep logs, is to read them every day and for the last day, and for a week ago. ;)
google docs? if you don’t need crosslinks inside articles, then it’s very good, IMHO
For developers (description of interfaces), it is quite normal to use %used_JP%doc and/or tests. The main thing is to keep up to date, but this is a problem for any documentation, but it's easier to document directly in code or tests (when using TDD) than to climb somewhere.
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question