|
|
|
|
|
by GarnetFloride
49 days ago
|
|
Location: Orem, Utah
Remote: Yes
Willing to relocate: Yes
Technologies: Technical Writing, Information Development, User Experience/User Interface (UX/UI), Electronics Engineering, Computer Engineering
Résumé/CV: https://www.linkedin.com/in/stephan-fassmann/
Email: stephan /dot/ fassmann /at/ gmail /dot/ com There are 2 kinds of documentation: how to make something and how to use something. They are very different.
When you are making something you need to document what it is supposed to do (because the code tells us what it does and bugs are when it does something incorrect). You also need to document why you decided to do it that way so when you go back in 6 months you can pick up more easily.
When you are making user docs you need to think like a user, mainly assuming they never used it before, and they just want to get that task done so they can do all the other tasks they have to do.
Documentation is customer facing because when docs work, customers learn to trust you. I create documentation that builds trust and help customers use the product successfully. I reduced tech support calls by 60% and increased support website lists by 40%. |
|