7 answers
Mia
Student
Snohomish, Washington
1
Question
Updated
564 views
What does Technical Writing look like?
When making a portfolio of my work, how do I know which pieces will get the most recognition?
What is a day in the life of a technical writer? Does it change depending on the level of work you do? (entry vs mid vs senior)
Login to comment
7 answers
Angela Browne
Director User Assistance
1
Answer
San Francisco, California
Updated
Angela’s Answer
When you're trying to start your technical writing career, not only is it a challenge to collect a representative portfolio but it's also tough to demonstrate relevant industry knowledge. Look for opportunities to highlight the craft skills or qualities that apply to any entry-level tech writing position. Things like an insatiable curiosity about how things work, being able to independently research a subject, and knowing how to gain an understanding of your audience and their information needs are necessary foundations for a strong and rewarding tech writing career and should be represented in your portfolio.
Speaking from personal hiring experience, I take a person's employment history into account when reviewing their portfolio of writing samples. For an early talent, or someone fresh out of college, I'll accept examples from their coursework, of course, but will always ask why they chose a particular sample and how they feel it relates to the position they're seeking.
The day-to-day of tech writers has a lot to do with the industry you work in, the size of the company you work for, and the culture of that organization.
For a tech writer just starting out, I generally don't recommend the start-up path. There's only so much your education can prepare you for and the rest, which is quite a lot, you can only get from on-the-job training. So I recommend looking for a position with a more mature company and a team with at least one senior writer. They'll have established practices, policies, and guidelines that will act as a bit of a security blanket as you get acclimated to the real work of creating and delivering content for real customers.
Regardless of the environment you end up in, prepare by doing adequate research.
Good luck!
Speaking from personal hiring experience, I take a person's employment history into account when reviewing their portfolio of writing samples. For an early talent, or someone fresh out of college, I'll accept examples from their coursework, of course, but will always ask why they chose a particular sample and how they feel it relates to the position they're seeking.
The day-to-day of tech writers has a lot to do with the industry you work in, the size of the company you work for, and the culture of that organization.
For a tech writer just starting out, I generally don't recommend the start-up path. There's only so much your education can prepare you for and the rest, which is quite a lot, you can only get from on-the-job training. So I recommend looking for a position with a more mature company and a team with at least one senior writer. They'll have established practices, policies, and guidelines that will act as a bit of a security blanket as you get acclimated to the real work of creating and delivering content for real customers.
Regardless of the environment you end up in, prepare by doing adequate research.
Good luck!
Thank you so much for the in-depth explanation of portfolios and the extra advice about the work environment. I'll be sure to research more about the different areas where one can technical write. Thank you again!
Mia
I appreciate this, thank you for the advice.
Mona
Angela, Welcome, and thanks for becoming a part of CareerVillage - an awesome group of people!!
Kim Igleheart
Kim Igleheart
Career Counselor | Police Officer
1668
Answers
San Antonio, Texas
Updated
Kim’s Answer
Mia,
Congrats on knowing that you even need a portfolio! You would not believe how many people don't know this! Please remember to make your portfolio available on-line, such as through LinkedIn.
There is a company in my city that does technical writing for aircraft. I am providing the link to their career page because it has a short video and also sound like they might respond back to you if you reach out to them. https://janacorp.com/careers/
Best of luck!
Kim
Congrats on knowing that you even need a portfolio! You would not believe how many people don't know this! Please remember to make your portfolio available on-line, such as through LinkedIn.
There is a company in my city that does technical writing for aircraft. I am providing the link to their career page because it has a short video and also sound like they might respond back to you if you reach out to them. https://janacorp.com/careers/
Best of luck!
Kim
Stephanie Scheer
Technical Writer
5
Answers
Appleton, Wisconsin
Updated
Stephanie’s Answer
I have not made a technical writing portfolio yet but I can answer your second question. This summer I am working as a technical writing intern. My main job is to help write and edit my company's public documentation webpages. A common task is when an engineering team creates a new feature, gives me the information, and I have to write an article/section/etc. Some technical writings are more difficult than others. You have to learn about the company's product and ask follow-up questions to other teams. For being an entry level technical writer, I would say the initial learning curve can be difficult but after you get to know the processes/teams/product better, it becomes easier.
Ryan Keawekane
Marketing Assistant Manager
3
Answers
Seattle, Washington
Updated
Ryan’s Answer
My advice is that technical writing doesn't only mean technology, software, computers, science. I worked as a technical writer for a consultancy specializing in business transformation (agile). The writing was highly technical but geared toward human development, change management, project management, team collaboration and facilitation. The point is technical doesn't only mean what people think of as technical: anything with any depth and complexity can require technical writing.
Chris Beckmann
Technical Writer
3
Answers
Saratoga Springs, New York
Updated
Chris’s Answer
A well designed, well written piece will get any reviewer's attention. Communication is not only about words, but also visual design - both contribute to the end product's effectiveness. The writing in any piece must be immaculate. Even minor punctuation errors divert the reader's attention, ding your credibility, and make them doubt your skills. You don't want that. In fact, as a technical writer, solid writing skills should be a given.
If you have something in your portfolio that's "pretty good" but not good enough, go back and edit it. There is nothing wrong with that. In fact, as you progress in your career, you will find that the quality of your writing not only improves but changes a bit in style. I believe it's best to show a recruiter the current state of your writing. Any why not? They aren't hiring a you from two years ago, they are hiring the NOW you, so why not sell them the current edition of you?
If you don't have anything in your portfolio you think will command attention, try creating something from scratch. Everyone is highly skilled at something, so pick a subject you know. Maybe you are really good at creating something in a certain piece of software. Explain how to do it in a step by step procedure and take and edit screen captures to support what you are explaining.
Invest (an investment that will pay for itself quickly) in a copy of TechSmith Snagit. I have been in the technical writing business for a LONG time and Snagit is one of the best made things for its purpose I have ever used. It's primarily screen capture and graphics editing software, but it is designed for technical documentation and also has templates for quickly generating sharp looking how-to instructions. You will learn a lot about presentation from a package like this.
A technical writer spends time on many things other than writing. First, they determine the goal of what they produce - who will use it to do what, which often can mean several kinds of folks who want to do several kinds of things. Then there is planning - what will the final product contain and how will it be organized? You will need to line up subject matter experts (SMEs), stakeholders, reviewers, and approvers so you know up front everyone who needs to be involved in your work.
It is critical that you plan everything up front - you must have a plan to change a plan, and you'll find plans change often in the tech writing business!
Each step of the way, a good technical writer keeps everyone informed on progress. No one likes surprises (a true understatement in technical writing).
You will need reviews, so put on your thick skin and take advice and criticism for what it is worth. Most times there is value in someone else's edits if you check your ego at the door. If you need to push back, be as knowledgeable as you can about grammar, punctuation, and sentence structure so you can explain your position.
As you advance in your career, you may tend to specialize in a particular industry. You will find you are learning A LOT about that industry, so find a business area in which you are really interested. In the beginning you relied on, and in the process learned a good deal from, the SMEs with whom you have worked. As you advance, you become an SME yourself at a certain level, and then your value rises.
Life lesson - find something you enjoy and you can't help but excel in it.
If you have something in your portfolio that's "pretty good" but not good enough, go back and edit it. There is nothing wrong with that. In fact, as you progress in your career, you will find that the quality of your writing not only improves but changes a bit in style. I believe it's best to show a recruiter the current state of your writing. Any why not? They aren't hiring a you from two years ago, they are hiring the NOW you, so why not sell them the current edition of you?
If you don't have anything in your portfolio you think will command attention, try creating something from scratch. Everyone is highly skilled at something, so pick a subject you know. Maybe you are really good at creating something in a certain piece of software. Explain how to do it in a step by step procedure and take and edit screen captures to support what you are explaining.
Invest (an investment that will pay for itself quickly) in a copy of TechSmith Snagit. I have been in the technical writing business for a LONG time and Snagit is one of the best made things for its purpose I have ever used. It's primarily screen capture and graphics editing software, but it is designed for technical documentation and also has templates for quickly generating sharp looking how-to instructions. You will learn a lot about presentation from a package like this.
A technical writer spends time on many things other than writing. First, they determine the goal of what they produce - who will use it to do what, which often can mean several kinds of folks who want to do several kinds of things. Then there is planning - what will the final product contain and how will it be organized? You will need to line up subject matter experts (SMEs), stakeholders, reviewers, and approvers so you know up front everyone who needs to be involved in your work.
It is critical that you plan everything up front - you must have a plan to change a plan, and you'll find plans change often in the tech writing business!
Each step of the way, a good technical writer keeps everyone informed on progress. No one likes surprises (a true understatement in technical writing).
You will need reviews, so put on your thick skin and take advice and criticism for what it is worth. Most times there is value in someone else's edits if you check your ego at the door. If you need to push back, be as knowledgeable as you can about grammar, punctuation, and sentence structure so you can explain your position.
As you advance in your career, you may tend to specialize in a particular industry. You will find you are learning A LOT about that industry, so find a business area in which you are really interested. In the beginning you relied on, and in the process learned a good deal from, the SMEs with whom you have worked. As you advance, you become an SME yourself at a certain level, and then your value rises.
Life lesson - find something you enjoy and you can't help but excel in it.
Atul Bhankharia
Sales
459
Answers
Mount Laurel, New Jersey
Updated
Atul’s Answer
If you want to become a technical writer - beyond English language proficiency, you also need some background in the relevant industry. Take some courses in that field.
In my line of work (software), the technical writer who had mastered English language needed to understand technology (telecom/cyber security ) that we were developing.
You do need to have a basic/fundamentals knowledge and should be able to understand from the software engineer to articulate properly to write a user manual or any relevant documentation.
Most engineers are not good at writing and this is where you come in play to ask relevant questions so that you make a documentation that is easy to read and comprehend.
In my line of work (software), the technical writer who had mastered English language needed to understand technology (telecom/cyber security ) that we were developing.
You do need to have a basic/fundamentals knowledge and should be able to understand from the software engineer to articulate properly to write a user manual or any relevant documentation.
Most engineers are not good at writing and this is where you come in play to ask relevant questions so that you make a documentation that is easy to read and comprehend.
Thank you, this is amazing! I really needed it.
Mona
Amy Liu
5
Answers
New York, New York
Updated
Amy’s Answer
I'm interning in technical writing this summer, so I can speak a bit as to what it's like. There's a lot of documentation work, as you might expect -- cleaning up current documentation, working with product managers to draft new procedures, etc.
One thing I overlooked starting out was how user-centric technical writing really is. The point of the work you do is so that users can understand how to use the product. You have to keep structure and phrasing in mind, and approach issues from the user's point of view -- where does their eye go on the page? what's the best terminology to use? what screenshots of the UI should be included?
You can get into technical writing from a lot of different backgrounds -- I know people who majored in English and people who majored in engineering who all ended up in technical writing.
One thing I overlooked starting out was how user-centric technical writing really is. The point of the work you do is so that users can understand how to use the product. You have to keep structure and phrasing in mind, and approach issues from the user's point of view -- where does their eye go on the page? what's the best terminology to use? what screenshots of the UI should be included?
You can get into technical writing from a lot of different backgrounds -- I know people who majored in English and people who majored in engineering who all ended up in technical writing.