How can you prepare documentation before developing a project?

Question

Documentation

Good day.
Can you please tell me if there are solutions for creating project documentation before starting development? I would like to somehow systematize all the ideas before development. Of course, you can sketch in a Word, but there may be specialized solutions that provide functionality for ordering and systematizing.
Thank you for attention.

Answer 1

Hey!
As far as I understand, you are not just interested in text documentation (respectively, the Word is not suitable), you are interested in what is done either in the design or modeling of information systems. There are software tools for different levels, for example, at the institute we were engaged in database design in the ERWin program. Lots of analogues. But if we take any general models, then, also at the institute, we worked with Rational Rose. But recently I got acquainted with SAP Power Designer. As for me - not very convenient, but solves its problems. Actually, there you can design a database - immediately make a script to generate the database. Then you can create a project structure with the addition of classes / interfaces, their method definitions, etc. Various programming languages ​​are supported (with limitations, for example, c# version 2.0 is supported, although the current version is 6), you can upload both from the program code to the model and from the model to pre-generate the code, but it's rather clumsy. There are, it seems, 9 types of models, how to cook it, read on the Internet. For modeling, database models, program structure with interface design are enough for me.

Answer 2

Try Confluence . Paired with Jira, BitBucket and other tools from Atlassian - generally poison. But it costs some money.
If someone throws a worthy free alternative, I myself will be grateful.

Answer 3

WIKI??? You put the engine on the server to yourself and fill it. Organize the structure the way you want. Or you put any convenient engine and deploy everything there.
But in general, the wiki is designed for documentation.

Answer 4

It all depends on WHAT you want to get and WHAT specifically is more convenient for you.
If the documentation is written by one person, then Word will be enough.
For teamwork, everything also depends heavily on the wishes ...

1. Word (using comments, etc.).
   
2. Google Docs.
   
3. Redmine (setting tasks + Wiki) or something similar.
   

Answer 5

Obviously there are very few requirements in the question.
In addition to wiki and gdox, I can also advise asciidoctor + github