If you are working on a complex writing project for a software manual or detailed product instructions, for example, your best source of information will be a subject matter expert or an SME. Technical writers can sometimes feel a little intimidated by the idea of contacting someone to take advantage of their knowledge. After all, in the long run, the author will also need to be an expert. Here are a couple of simple tips to get the most out of your expert:
Prepare
Too often, the SME you need is a vital member of the project; They can be a lead developer or project manager, so your time is valuable. They would not like to waste time with which they could be achieving other goals with an unprepared technical writer. Make a list of questions in advance and do your homework, so review the basic functions of another person before sitting down with the subject matter expert.
You will also want to make sure that your questions have not been answered in any other documentation that has been prepared, get the project specifications, user requirements and any help files and read them through. Do not forget that SMEs are a key contributor to the rest of the project and you will not want to spend too much time reviewing readily available data. But don't be afraid to ask if you don't understand something either; After all, if you don't understand it, when you write your manual, your users won't have the hope of being able to understand it.
Work at your time scale (but press if necessary)
Ideally, deal with a receptive SME that happily gives you all the information you need so you can get your perfect user documentation. To achieve the best, you will want to work when you feel comfortable doing so, so organize a meeting and be on time. But … because these people are key members of the project, they will often want to dodge their meetings for things they perceive as more important. Do not forget that your work is also important and that you cannot launch a product (or a launch) without the correct documentation if you have tried and have not worked according to your calendar, you & # 39; 39, will have to be a bit aggressive. Regular personal appearances requesting a meeting are often a good way to wear resistance and set it in motion.
SMEs are excellent project resources for the technical writer, the ideal way to work with them is to respect their time and use them as a last resort to lighten dark spots. You should seek to avoid confrontations with them unless it is absolutely necessary since you cannot do your job without your help.
If you want to relish the Sound Aliveness: Making money in the solace of your own plate writing online, then this is for YOU!: Click Here
Comentarios
Publicar un comentario