Project documentation

[Michael1968]

Hello together,

if you have a project, how do you write the documentation?
because I have different B4X/Raspi/ESP projects and subprojects I would like to document them in order to be able to understand them later(I am too old to remember after some time).

I do not need a web connection/hosting at the moment.
I want to insert code,images,pdf,schematic
i like this style https://nodemcu.readthedocs.io/en/release/

I think about using ABMaterial, but I only need static pages and I think ABM is oversize.
is banano a possibility?
I know rwblinn has written a great tool for his "HowTo's" some years ago, but it is a database solution.

or is "readthedocs" the best choise.

What do you think?

best regard
Michael

 

[xulihang]

I use readthedocs for my projects: https://docs.basiccat.org/en/latest/

 

[agraham]

I've used HelpNDoc for many years now. It's free for personal use and the added attribution banner is quite discreet.

HelpNDoc Help Authoring Tool - Create Help Files, User Manuals and eBooks

 

[rabbitBUSH]

if you have a project, how do you write the documentation?

I know there was substantive thread not that long ago, here in Chit Chat I think. But, can't find it now (seems like Chit Chat is not searchable - or i just didn't ask the right questions).

That thread dealt with commenting one's code and heading one's function sections etc. etc. That's about the best way to do this documentation.

But, if you want to go further then I once installed Docuwiki on a server which was private : so it would be a bit similar to the examples in the posts above. A friend of mine just wrote a set of PHP scripts that wrote to a text file - just because this meant an ordered way of entering the details for the documentation and then presenting it later on - and, of course, it was searchable. Not a very complicated thing to knock up and doesn't have to be "databased".

The above assumes that this documentation is simply for your own reference and not as user notes / manuals for users who have purchased a software product from you. Then one of those above would do I guess.

But, nothing beats a set of good comments within the code's text - this is good for others who may end up maintaining your code later and largely irrelevant to purchasers of the product.