What is the best way to write technical documentation for a working project?

Question

Documentation

It so happened that I was appointed senior, on a dying project, zasran in the trash.
According to which there is no documentation and there was no smell of tests.
I want to start documenting processes in particular.
So-how you need to understand what-how it works and for the team to see it.
And it will come in handy for writing tests and refactoring.
I have already looked at some overview of the documentation.
But since people here are very interesting, I decided to consult.
I would like to find something not very difficult to master, so that it does not take a lot of time.
If anyone has done something similar, I'd love to know.

Answer 1

IvanN777 To get your thoughts in order, start with this answer: What's the best way to do company documentation?

Answer 2

Our team uses DokuWiki. There is a search in the documentation, the history of previous edits, etc. Better than Word.
Installation in Ubuntu/Debian Linux is simple, through a regular manager.
As far as documentation is concerned, it is worth making a map of the various parts of the project and linking to them in a hierarchy. You can attach images of various diagrams, links to external resources, etc. It is also convenient to refer to some internal systems, say JIRA:
DokuWiki uses namespaces to maintain a hierarchy.

Answer 3

you add comments in the code and hints start to appear in the IDE, and you can also generate html documentation
https://www.phpdoc.org/
https://github.com/phpDocumentor/phpDocumentor2

Answer 4

I would look towards wiki engines. In my opinion, the most functional, including plugins, are mediawiki, dokuwiki, twiki, xwiki, confluence. In my opinion, the last 2 have a more user-friendly interface.

Answer 5

Microsoft Word, Google Docs

Answer 6

Use MD