Assemble in 60 seconds: in the role of navigator — technical writer
-
-
40 min
A technical writer often develops a single document for “all occasions” — the range of possible application scenarios can be very wide.
Let's imagine that we need to prepare instructions for updating a mobile application: we don't know in advance what hardware the user will have, we don't even know which tablet or phone, which OS and which version, from which version it is necessary to update. Listing possible conditions complicates the text. Such documentation is difficult not only to develop, but also to read — you have to explore all possible options and choose the right combination.
At Yadro, we have developed an approach to developing a dynamic document for changing conditions. Let's look at it using the example of the work of a technical writer in the YADRO production line — we will participate in the development of assembly instructions, observe the server assembly.
How to identify a variable document? How to optimize its development? What exactly is variable in the document?