Technical Writing 101 Part 2
The first step is to find out their level of knowledge about the subject matter. Are they… Expert level? - at an advanced level on the subject matterSemi-expert level? - at an intermediate level on the subject matterNon-expert level? - have no prior knowledge of the subject matter
The second step is to find out their role in the organization. Are they…· Superiors? - the highest of authoritative figures within the organization, such as the President or Vice President or Director. Those who make decisions that affect the whole organization. · Subordinates? - readers at a level within the organization lower than the technical writer. All they care about is how the document affects their job.· Peers? - readers on the same level as the technical writer, but not necessarily the same department or field.
And the third step is to find out why they will be reading your technical document in the first place. Is it because…· they have to? or have been ordered to by their manager?· they are truly interested in the topic?· they will only be using it as a reference while completing their daily job tasks? You may be wondering why these steps are even important to a technical writer. Well, the reason is because if you write or design your document in the wrong context, color or layout it could make or break the ENTIRE project. For example, you do not want to write a document to superiors with no knowledge of the subject matter in highly technical terms, nor do you want to write in a condescending manner either. There has to be a professional balance between the two that will engage the learner and help them assimilate the information efficiently and use the technical document effectively. Let's look at another example.
You are writing for a team of your peers who have an intermediate to advanced knowledge level. What do you think would be the response of the readers if you created a document that explained even the lowest technical term such as what is a 'mouse' or how to "click"? They would probably be bored and offended at the same time, don't you think? So again, the key is to define your audience by asking as many questions as possible. If you end up with too many levels and organizational roles within your audience, you may need to create 3 separate documents, such as a Beginners Guide, Intermediate User Guide and Advanced User Guide. In Part 3 I want to focus on how to gather resources and from where, and what are graphical aids or cues within technical documentation and how to create them. Until next time…
Related Tags: guide, writing, audience, technical writing, documentation, technical, outline, user guide
Cheryl McNeil, the owner of Graphik Connexions, started her business back in 1996, as one of the first women in NJ in the field of "Technological" Instructional Design. With a Masters degree in Project Management and more than 10 years of training and instructional design under her belt, she is skilled at course curriculum writing, Soft Skills and Technical training, ELearning design and development, PowerPoint presentations, and technical writing.
Your Article Search Directory : Find in ArticlesRecent articles in this category:
- Current Affairs Articles - Obama on Ground Zero Mosque: Rights for Muslims, Tough Luck for Americans
Only a few short months after snubbing the National Day of Prayer President Obama continued his war - Spiritual Articles - After Armageddon
When we look back through the smoke filled skies of a nuclear winter where all is gone except the fe - Current Affairs Articles - America and the Doctrine of the Last Chance
The History Channel cooks up a nice pot of Nostradamus and eschatological soup with their multi epis - Video Games Articles - A better way to get the most value for your used games.
As players, we usually trade-in our used games in store (Gamestop/EB) and buy used ones from them. - Business Articles - Know About Different Benefits of Sharepoint Administration
Share-point is a platform where people can work together very easily. By using sharepoint administra - Current Affairs Articles - Obama Courts Latino Votes at Arizona's Expense
Every time the President speaks, makes another appointment or ramrods a new bill through the democra - Spiritual Articles - Are You Religious Bigot? Take the Quiz!
This quiz is for fun, and although some of the questions will make you stop and think, please don't - Import - Export Articles - How to get Windows XP driver updates-5
Getting driver updates for an individual's laptop or computer with Windows XP operating system const - World News Articles - HGH Facts - Health benefits and also Side Effects for HGH
Human growth hormone is really a normal occurring hormone that's made within the body which controls - World News Articles - Finding A Thinning Hair Treatment That Works
Trying to acquisition a abrasion beard analysis that re-grows new affection beard is appropriate up
Most viewed articles in this category:
- Doughnut Hole Expected to Grow
A recent report in the USA Today, reported that the gap in the current Medicare coverage commonly re - Human Globalization
Activity in the sense, the central component of globe, we humans have been showing activeness bo - Writing Abilities Development
It has been proved that writing abilities can be developed together with inspiration. A thought - Snowboarding Tricks 101
I like the floating feeling you get on quarterpipes, it feels like you're hanging in the air and you - Russian Expansion To The Middle East
The period of the Cold War created an excellent opportunity to expand Soviet Union influence. On - Girl Tattoos Tell You Lots About The Girl
How often, when admiring girl tattoos have you said - It suits you? It happens a lot with girls - How to support charities In your Local Area By Getting Involved
Charities are created to help people find ways of dealing with situations that can't be solved i - Christian Sex - 7 Barriers to Fulfilling Married Sexuality
Many Christian married couples have yet to experience a fulfilling sexuality. Yet, it is an essent - Tales of New York
A Bronx Tale deals with bringing up children in a big city, dangers of gangster life, and stereo - Universal Civilization
Early civilizations of the world were divided and isolated by geographical locations and boundar
