11
I came across a situation here that prompted me to look for some software that would allow me to create a well done user manual.
What happens is that I was tasked with developing the system user manual that we have here for a request from a client. The system is giant and if I were to do in hand a user manual would last for months.
So I decided to look for some software that automates some part of this work to help me.
Well, I found some software that helps, almost all are paid, there are some free.
It’s them: Helpndoc, Dr.Explain, Doxygen, Ckeditor and Help&manual. Some provide Apis for integration with some languages.
My doubts are:
- How can I develop a good user manual?
- Is there any standard or pattern that should be followed when making a manual?
All are good, test all and see which one suits you best, develop a manual, depends a lot on the complexity and public of the manual, and the standard would be with a good Portuguese and follow ABNT :D kkkk standards
– Rod
@Rod, have you ever used any of them? KKKKKK, that’s a very important detail!
– Érik Thiago
I used only the Ckeditor for editing texts, rs
– Rod
@The documentation tag has two links in English that can be a starting point. I will update this Wiki according to the responses that appear here.
– Leonel Sanches da Silva
@Rod I found the Ckeditor very basic... I’m testing the Helpndoc, and apparently it’s quite complete.
– Érik Thiago
@Gypsy Rhyming Mendez, Porxa cara, thanks a lot, I’ll give a read!
– Érik Thiago
If it is a software of use via WEB it would be interesting to go for documentation in videos first, instead of texts. A quicker way to make a manual is to use the FAQ scheme before going documenting steps. Often the steps depend on understanding legislation or internal processes of the company what will need deepening that have nothing to do with the software itself.
– Marcos Regis