You don't need all details from the start. Tech writers job is helping you get from the zero-point to the hero point. The amount of stuff unknown is frightening. Imagine working with a completely new tool on your new project. They entangle a mess, find what is relevant, and share it. They design how to share the information. Moreover, a skilled tech writer goes even further. Technical writer facilitates this process of technical sharing. Text can be anywhere in the world, at the same time. Well-documented software answers almost all questions leaving friction and frustration at bay. So what now? That is when technical writing comes to the rescue. She is also working on something important right now. Somebody probably worked with that code, so you don't need to ask Prokop you may ask Adéla. So, how to fix this? You can turn the single-person resource into multiple people. The knowledge debt would creep back and back. If everyone worked like that, nobody would do anything, ever. It is frustrating to sit and wait for just enough information. You want your answer now, or the project burns money. The person who wrote that particular piece of code is probably working on something else (and can be living 10 hours in timezones away from you). But teams get more extensive and more remote. New library in your project? What does this function does again? How can we fetch this resource? Do these questions sound familiar? In the team, you would go to the person who wrote questioned software and be like Hey, Prokop, how does it do this?. Since you are not the only person working on A with only your hand-created tools, everything today requires enough info. Technical writing (sometimes written as tech writing) at its base is a process of information and knowledge sharing.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |