D
D
Daniel2017-12-29 05:24:56
Documentation
Daniel, 2017-12-29 05:24:56

In what format should the program documentation be written?

I am compiling a small game (in particular, on js, electron, then transfer to c++ qt is possible)
To begin with, I work with a description.
Wrote a huge bunch of block diagrams of algorithms. And in the process it is necessary to describe classes and structures, as well as many functions, file locations in directories, etc.
Question. If the program or format is some where it is convenient to describe everything. Like Excel, otherwise there are too many spaces in the notepad. Those. everything that I write, I will then insert as comments to the code itself. And in general, how to properly differentiate the work and break the stages into STAGES.

Answer the question

In order to leave comments, you need to log in

2 answer(s)
A
Alexander Glukhov, 2017-12-29
@daniil14056

I write documentation for myself in Markdown format. I write for the wiki at work.
Advantages of Markdown format (spoiler: more widespread)
1. You can make a mini wiki from text files with: dynalon.github.io/mdwiki
2. You can upload your articles to Evernote
3. Gitlab/hub renders these files automatically.
4. Clean text and tags, files are easy to store, transfer and edit.
Cons:
1. Anyway, you will need to get used to writing without a WYSIWYG editor. Because it's more convenient
2. At first, a lot of time is spent on registration, as you get used to it, the time is reduced.
Build a block diagram where it is convenient for you, for example, I prefer Visio from my student days. Then export to a picture of a format convenient for you. Attach to MD article.

X
xmoonlight, 2018-01-24
@xmoonlight

1. For Documenting JS code: documentation.js.org
2. For flowcharts (including drill-down dives on click into other related charts) https://www.edrawsoft.com/

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question