Difference between revisions of "Information Development"
(Created page with "Information Development is a the new title for technical writer, because we don't just write anymore. We now create text, visual, audio and video content.") |
|||
| Line 1: | Line 1: | ||
| − | Information Development is a | + | Information Development is a new title for a technical writer because we don't just write anymore. We now create textual, visual, audio and video content. |
| + | |||
| + | Who is our audience? That is the foremost question. Most of our audience are sysadmins, people who are skilled in computer use. but some of the products are available to end users so that documentation needs to be more basic. | ||
| + | |||
| + | In any case, we need to use plain language [https://www.nngroup.com/articles/plain-language-experts/] to get the message across, because most people will not be experts in our software and don't want to be. They just want to get their job done and our products are generally a small part of their job. Making it easy to find what they want to do is vital. | ||
| + | |||
| + | When it comes to enterprise software we can spend a lot of time with the developers, but its the support team that knows what clients are calling in regularly about. Answer those question in the documentation and that will make support's job easier. | ||
Revision as of 14:34, 10 October 2017
Information Development is a new title for a technical writer because we don't just write anymore. We now create textual, visual, audio and video content.
Who is our audience? That is the foremost question. Most of our audience are sysadmins, people who are skilled in computer use. but some of the products are available to end users so that documentation needs to be more basic.
In any case, we need to use plain language [1] to get the message across, because most people will not be experts in our software and don't want to be. They just want to get their job done and our products are generally a small part of their job. Making it easy to find what they want to do is vital.
When it comes to enterprise software we can spend a lot of time with the developers, but its the support team that knows what clients are calling in regularly about. Answer those question in the documentation and that will make support's job easier.
