What software (or script, code……) should I use to make a manual for my software? [closed]

  Kiến thức lập trình

I am working on a C++ library for my work. I want to write a manual to introduce details and usage of every class and function so that I can make others understand my code and library usages easily. I don’t know much about writing a manual so I need some advice from you all. I would appreciate every single advice from you. That would be really helpful to me.

I used to write manuals using some Latex scripts. However, I find it quite laborious and I do not know how to realize some of my demands.

My expectations are as follows:

(1) The manual shows clear structure (both for colors and documentation structure) of the library (namespace->class(and class members)->function…).

(2) I can use hyperlinks to get to every functionalities.

(3) I can write logs and for every functionalities.

(4) I want to link some urls (or file? is that possible?) to the test case I use to test all every single functionalities.

(5) Any other demands you think is needed.

And I am using a Mac OS device so I would prefer some scripts or softwares that support Mac OS.

LEAVE A COMMENT