Technical Communications
Here are some requirements I take into consideration when it entails technical communication projects.
Identify objectives and determine the best audience, consider motivation to learn, determine right platform or medium to showcase learning experience.
Target Audience
Considered who is your primary (intended) audience, but also who may be a secondary audience?
Action Item
Do you want them to learn how to do something or feel empowered by the information provided? Do you want to provide action steps that will help them complete a task or future task?
Accessibility
We naturally design and create documents for “ourselves” so it is important to think about the audience(s) that are not like “us” that may encounter our deliverables.
For example: Let’s say a colleague wants to use acronyms to describe a list of action items that need to take place in order for a financial institution to have the proper paperwork for renewals. They are under the impression that since this is a “renewal” whomever is filling out the paperwork if familiar with the terminology. But what if someone was new? Or recently took on additional roles that required them to handle the paperwork moving forward? Would that person understand how to fill out the form or know that it was a requirement?
With the documents and content I create, I avoid assumptions. We can’t assume that the person encountering our content knows “anything” because they stumbled upon our website and found themselves on a specific page. While we need to be mindful of primary audiences, we cannot ignore our secondary audiences.
If there’s an acronym in a document, unless you have a valid reason not to, it should always be defined the first time it’s used.
Usability
I firmly believe that content accomplishes nothing if it is not usable and accessible. What you’re creating should always be usable or readable. That is why all of our content for the most part is web-based for translation and ADA reasons. Also why we have different tones for B2B and B2C audiences, the content is still written in a way that either audiences can stumble upon any page and be able to understand the context.
Organization and Document Design
If it doesn’t make sense to you, it sure as heck won’t make sense to anyone else.
Is it organized, structured, and designed for optimum usability? Consider including the following to aid usability:
Headings
Subheadings
Lists
Page numbers
Labeled references
Research and Critical Analysis
I look at the text, but I also review every caption, workflow, diagram, equation, figure, etc. because content is content.
A technical writer should be able to write on any subject matter and/or topic. We do not have to be experts, per say, but we need to have a firm understanding and be able to grasp what we are digesting to “translate” it for our audiences.
Research is my fiend – I never stop learning.
Project Management
I have become a project manager – by default. In my previous position I led three different programs, which required an immense amount of project “juggling” and management. I had deadlines to meet and worked with direct and indirect co-workers, as well as managed direct and indirect employees.
I was responsible for:
Developing project proposals, and potential estimates
Creating timelines
Tracking progress
Developing status reports
Assessing risks
Budget Management
Open Communication/Feedback
Cross-functional Collaboration and Communication
Having a background in marketing communications, I know how important proper communication is within the work setting.
You need to be able to
Listen, speak with managers/leadership, work effectively with SMEs and aske the proper follow-up questions if you are unsure or confused, incorporate feedback and report back to your manager/supervisor with status updates and drafts.
Compliance (Standards and Regulations)
Whether the industry is insurance, financial, healthcare, SAAS or something else, your content needs to be compliant.
Fundamentals
I am a strong writer and editor, have years of experience in proofing and understand grammar basics.
