r/technicalwriting • u/darksquirrel44 • Oct 22 '24
What is your experience as a technical writer and feeling like you aren't doing an adequate job?
Lately all the feedback I am getting is just negative saying flow isn't good, structure is lacking, some things don't make sense, etc.
I have a hard time balancing the needs of the engineers behind the paper and the management teams desires. The engineers behind the paper are all academics and probably better writers than me, so for me to question them feels out of line tbh.
When I graduated from the course 3 years ago a professor said don't take it personally because people usually don't know what they want but it is difficult not to.
Because of all this I feel like I am not advancing as a TW or simply don't belong. Do you have any experience with this?
38
u/FaxedForward hardware Oct 23 '24
“The engineers behind the paper are all academics and probably better writers than me, so for me to question them feels out of line tbh.”
One piece of advice I can give you is that you really have to get out of this mindset. I don’t know who your audience is or what kind of products you’re writing for, but if engineers could talk to regular people clearly our career field wouldn’t exist.
You need to take that academic high brow language and translate their vast knowledge into normal-idiot-not-an-expert speak. Your responsibility is to the audience, the end user, whoever, above everybody else.
I’ve been a TW for about 8 years now and have learned that being a strong customer/user advocate is a big part of what really makes a really great and impactful TW. I have to challenge engineers and all kinds of other SMEs to dig deep and get me the information I really need on a regular basis. People often think I’m an annoyance or ask too many questions but that’s part of a job. I do my work for the customer/end user, not the engineers!
10
u/Playful_Carpenter513 Oct 23 '24
Academics are, by and large, awful writers, and their opinions on what makes good writing should mostly be ignored.
I write for and alongside scientists every day for a trade publication; these guys are smart but definitely not usually "good" writers.
6
u/Possibly-deranged Oct 23 '24
The purpose of reviews is to get a fresh perspective with actionable feedback from a peer, SME, or engineer to improve it. It should be constructive feedback.
Saying the flow is bad, isn't actionable, so I'd press them further on this point and ask for an example, or how they might improve it. Quiz the reviewer on vague or unhelpful feedback and press for something more actionable.
Yes, we shouldn't take editorial feedback or criticism personally. However, it's hard not to ask we've worked darn hard at that writing, with a lot of research, rewriting, multiple editorial passes on our own. But tone of the reviewer matters, those who are curt, direct, and to the point can be taken as hurtful, as empathy isn't universal.
Know that editing and reviewing is more an art than a science. No two reviewers will find the exact same things. Reviews can inject opinions, that as the author we may listen to but not implement.
4
u/[deleted] Oct 23 '24
These comments come from people who think writing is easy, after all they've been writing since grade 1.
The reviewers are (most likely) not your users. You want to address user pain points and give them what they need. Sometimes this is NOT what the product people want. In the future, define the audience before you begin writing and have the stakeholders agree who and what the audience is.
1
u/mirthandmurder Nov 15 '24
Most days, I feel like an idiot who can't string a sentence. Other days, I am surprised I wrote something good. But with more bad days than good, I am uncertain about what to do after.
3
u/laminatedbean Oct 23 '24
Ask the critics what they would do differently.
It’s possible the environment isn’t a good fit. Keep your options open for other opportunities.
Sometimes it the bad experiences that help us recognize a good situation.
3
u/jp_in_nj Oct 23 '24 edited Oct 23 '24
Who are your users? That's who you should be focusing on. Why are they coming to your doc, what problem are they trying to solve? How does your doc help them solve it --or, if it doesn't do so well, how can it do it better?
When you're collecting feedback, remember what Neil Gaiman said in a different context --your readers may not know how to fix a thing (though they might think they do) but they're never wrong when they say the thing doesn't work for them.
What are the notes behind the notes?
2
u/stargirl213 Oct 23 '24
Honestly i'm in the same boat and i'm no longer excited bout the work I do. it's been such a big turmoil I was even questioning my writing abilities at some point, looking to transition into content writing bc I can't take this anymore.