How we at "Active" write user documentation. Why is it important



What does the user want to see in user documentation? What annoys him about her? Everyone who writes such documentation asks himself these questions, but not everyone answers them correctly. A very small percentage of users read the documentation. Let's see why and how to make user documentation effective and change user attitudes towards it.





Negative experience hinders us



: - -, , . β€œ ” . , . 10 , , β€œ ”. , - , , .



, - - , ? , . ?



β€” .





-, . : -, . , .



, . , . , , , . ? , , .



, , , . , , , . , . , , . - , . .



-. - , , , - . , – .



, , . Let’s go!





, . , . , .



, 20 . 25- , 40 .



:



1. . , . , β€œ ”. . , 1 . , - . , β€”





2. . , , . 2 + 2 . , . , . β€” , .





3. . , , . , , , , . , . 20 + 1 + 1 . β€” .





4. . , β€” . , . 2 . . β€” .





5. . , . . 2 + 1 . β€” .





6. . . . 2 . β€” .





7. . . 1 . β€” .





8. . . , . 4 . β€” , .





9. Publication of the document. We publish the document on our website on a special page. Let's add 20 minutes of the site administrator's work.





Total:





It turns out that 7 people are involved in the documentation process in our company. Each has its own role in this process and it cannot be said that someone is less or more important. In your company, this process can be structured differently.



After such a detailed analysis, it probably became clear why it is worth considering not only the salary of a technical writer when assessing the cost of user documentation.



100 thousand rubles or dollars



, . - . β€” . , , , - β€œ ”.



, β€œ ”, 5 5 , . , , , - . , .



. :



  • , ?
  • ?
  • , ?


See you soon!




All Articles