Answer the question
In order to leave comments, you need to log in
What is the best way to write user manuals?
Good afternoon.
There is a company that produces physical devices and software for them.
It is necessary to write a user manual for each of the products, as well as a technical specification for the devices.
Tell me, where can I read about writing and compiling such documentation? What software is better to use (because it turns out a sufficient number of documents and it will be impossible to figure it out without version control / convenient structure)?
Answer the question
In order to leave comments, you need to log in
ferdi
1. If you directly answer the question, then with a variety of devices, modifications of devices and software, versioning, etc. you are most likely suited to single source technology. What is it, why is it needed and other aspects - see here: https://vimeo.com/240324661
2. If you approach the issue more correctly, then you first need to set a goal. What do you want from the documentation?
Then let's start from here: What is the best way to make company documentation? and gradually build a picture in my head.
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question