DEV Community

Cover image for 5 types of engineers I met as a Technical Writer
Klaudia Grzondziel
Klaudia Grzondziel

Posted on

5 types of engineers I met as a Technical Writer

Relatable memes on collaboration styles

Being a Technical Writer in an engineering world can be tough. We work closely with engineers, but we're not engineers ourselves. Our job isn't to code, but to deliver a product that's well-described and clear for the target audience. This requires us to go around and bother engineers with questions, often uncomfortable ones, and keep them away from what they want to do most – coding.

In my career, I've met engineers with very different attitudes towards documentation. Ever wondered what engineers look like from a Technical Writer's perspective? Spoiler: it's a mixed bag. I've divided them into 5 main types, each illustrated with a meme below.

Note: I use "he" throughout this post for simplicity, but these types are gender-neutral – I've met all of them in every gender.

1. Good boy

A meme of a smiling golden retriever puppy with the text

That's our favourite boy! If he was a dog, he would definitely be a golden retriever. He's a perfect collaborator – always thoughtful, helpful, and truly engaged in the project. You're not afraid to ask him questions, knowing he won't judge you, but take your feedback as something valuable that will help improve the docs. He carefully reads your comments, takes an active part in brainstorming, and takes your feedback to heart, so that next time he publishes a document, it will be even better. I even remember fighting with my fellow Technical Writer colleague over who would work on the docs with our golden boy.

Definitely the best type of engineer to work with!

2. Mr. Better

A

"Everyone can write, it's not a big deal", thinks Mr. Better. He ignores or rejects any review comments, and he's always sure that his docs are perfect and don't need any improvement. Prerequisites at the end of the document? "That's the intended design". A request to make the concept clearer? "I don't see the problem, it's clear enough". A suggestion to add more details? "I don't want to make it too long, it's already long enough". He's the one who always says, "I know how to write docs, I'll do it myself", not understanding that writing technical documentation is not only about putting words on a page, but also about structuring information, making it clear and concise, and considering the audience's needs. The result? A document full of jargon, unclear explanations, missing information, and a confusing structure that's more frustrating than helpful to the user.

Probably the most demotivating person to work with.

3. Jon Snow

A meme of Jon Snow from Game of Thrones looking confused, with the text

Every company knows this guy. You approach him to ask a question about a project he's supposed to maintain, but as soon as you ask, he looks at you with a blank stare and says, "I don't know". You ask him again, maybe rephrase the question, but the answer is always the same: "I don't know". You start to wonder if he really knows nothing, or if he's just pretending so that you won't ask him to write docs.

There's also another version of Jon Snow who knows nothing but pretends to know something. He confidently gives you an answer that sounds like it should be correct, but when you think about it, it doesn't make any sense. You ask him to explain it further, and he starts to ramble about something that's not even related to the original question. This type of Jon Snow is even more dangerous, because he can lead you to wrong conclusions and make you waste time chasing something that isn't true.

4. Minimalist

A Mocking SpongeBob meme with the text

The Minimalist thinks that documentation is overkill. Code itself is enough. You approach the Minimalist with some questions about the feature he just shipped, hoping to update the docs. He looks at you like you're an alien. "We don't need documentation, the code is self-explanatory", he says. And if you push back? "If someone doesn't understand the code, they shouldn't use the feature".

The funny thing is, ask him to explain his own code six months from now, and he'll stare at the screen with the same blank look as Jon Snow. But that's a future problem – right now, the code is obviously clear, and writing it down would just be a waste of time.

There's a softer version of this type, too: the one who admits he doesn't know how to write docs, or that he doesn't have time. That's fair – that's literally why tech writers exist! But more often, it's just an excuse. He thinks docs aren't important, that nobody reads them anyway, so why bother?

5. Robot

A meme of a humanoid robot with a blank stare and the text

You open a diff and see a big, never-ending pile of docs. You scroll through them, and reaching the end takes you ages. You decide to give it a try and start reading the content, but you quickly realize that even though it's written in English, it's definitely not written in a human-readable manner. Everything is generated. It reads like Lorem ipsum — and that's about all you get out of it. You decide to reach out to the author and ask some questions. As a response, you get a generated answer copy-pasted directly from ChatGPT:

Absolutely — I can update this section so the documentation is fully comprehensive and self-contained. Want me to handle that next?

You ask yourself: "Is there anybody out there? Or is it just me and this robot?".

Conclusions

Time for some honest self-reflection. Which type of engineer are you? A Good Boy, hopefully? Or do you recognize a bit of Mr. Better or the Minimalist in yourself? Or maybe you're a completely different type not mentioned here? Let me know in the comments, and feel free to share your own memes! 😁

Top comments (42)

Collapse
 
francistrdev profile image
FrancisTRᴅᴇᴠ (っ◔◡◔)っ

The funny thing is, ask him to explain his own code six months from now, and he'll stare at the screen with the same blank look as Jon Snow.

lmao.

It's all fun and games until they actually remembers it. Had a friend like that XD

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

That counts as a superpower, I guess 😄

Collapse
 
narnaiezzsshaa profile image
Narnaiezzsshaa Truong

I'm the architect who writes the documentation that engineers don't realize they're following.

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

Why don't they realize? Do you mean you write architectural designs that engineers should follow for implementation? In this case, it's always good to have such docs as a reference and a checkpoint for what the team wants to achieve. Even if it's just an internal documentation, without it the goal would get blurry. Moreover, design docs can be later transformed into architecture docs for the project.

Keep doing your job 💪🏻

Collapse
 
narnaiezzsshaa profile image
Narnaiezzsshaa Truong

Engineers don’t realize it because the documentation I write isn’t a checklist of instructions—it’s the architectural substrate their decisions end up conforming to.

I design the conceptual boundaries, invariants, and failure‑mode constraints that shape the system. By the time engineers are implementing, those structures feel “obvious” or “natural,” so they don’t always see the architecture they’re implicitly following.

Good design docs absolutely matter—but the kind I write operate one layer deeper: they define the rules of the world the implementation lives in.

Thread Thread
 
klaudiagrz profile image
Klaudia Grzondziel

Glad to see that you realise the importance of the docs you write 🙂 It's actually a foundation for the implementation. I think this should be the starting point for every project and every big feature.

Collapse
 
embernoglow profile image
EmberNoGlow

Type 6: Vibe Coder ✌
This is a case where the code works and you know its algorithms, but you don't know what's under the hood.

Good article!

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

So the mix of Jon Snow and Robot, I suppose? 😄

Collapse
 
embernoglow profile image
EmberNoGlow

You have to experience this for yourself to understand. It will be something unique if you learn to use AI as an assistant, and not as a replacement.

Thread Thread
 
klaudiagrz profile image
Klaudia Grzondziel

That's what I'm discovering now and what I'm trying to introduce in my company. Unfortunately, I see a lot of people misuse AI, telling it to simply generate the docs for the feature and not even checking the output later. What I get is a load of text that is too heavy in implementation details, hard to understand, and definitely useless for the end user. As a Technical Writer, my job is to make it good, but it's much more difficult and time-consuming to extract useful content from this big pile than to go with the old style "messy short draft + dev interview".

I also believe that using AI as an assistant is the only correct way to use it; we are still on our way to learning how to do it right, though.

Thread Thread
 
embernoglow profile image
EmberNoGlow

I used him as a teacher and learned a lot. If you're interested, click

Collapse
 
csm18 profile image
csm

One part of our heart is good and says to be nice and collaborative.
But on the other part, ego stares!
And when tired, we become robots.
And when mind is off, we become gpt lovers
So, all of em, based on place, time,team, situation and also season!

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

... and the intake of caffeine, as Julien mentioned above 😄☕️

Collapse
 
javz profile image
Julien Avezou

Nice article! Technical writer sounds like a fascinating job.
I would say I can be a golden boy if I had my cup of coffee in the morning :)

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

Thank you, Julien! Obviously – no coffee no workee ☕️🙅🏻‍♀️ I suppose this works for many professions 😄

And yes, technical writing is very satisfying! Especially seeing the project getting properly documented over time and engineers getting better at documenting! 💛

Collapse
 
javz profile image
Julien Avezou

Haha very true !

What is your definition of 'properly documented', ie. what makes good documentation according to your experience ?

Also what arguments do you give to engineers to convince them documentation is important ?

Thread Thread
 
klaudiagrz profile image
Klaudia Grzondziel

Glad that you asked! 💛 I'd say good documentation is about two things:

  • information is easy to find
  • content is clear to the target audience

If the user cannot find the information they are looking for, they will quickly get discouraged. That's why easy navigation and a clear documentation structure are crucial, especially at the beginning when the user doesn't know the documentation portal. Also, you must know your target audience and adjust the language and the level of detail to their needs. Content that may be helpful for ops will not necessarily be understandable for an end-user.

Unfortunately, convincing some devs of the importance of docs can be a way through hell 😄 Some of them learn it the hard way – for example, when they find an answer for some production issue in the docs. Fortunately, most of the time, it's enough to talk and make the engineers aware of the end user's needs. In the end, we have a common goal – to deliver a usable product 🙂

Thread Thread
 
javz profile image
Julien Avezou

Got it! Thanks for detailing this.
If you are looking for future post ideas, a deep dive into documentation best practices and sharing some of your key learnings would be super helpful, I would definitely read it :)

Thread Thread
 
klaudiagrz profile image
Klaudia Grzondziel

Thank you, this is very encouraging! 💛

Collapse
 
harsh2644 profile image
Harsh

Wao Great Article 😉😄

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

Thank you for your kind words, Harsh! 😊
Publishing a first article is definitely a big step out of the comfort zone!

Collapse
 
itskondrat profile image
Mykola Kondratiuk

honestly, the engineers who refuse doc questions usually have the most useful knowledge - they’re just protecting context that takes 10 minutes to explain but 10 days to rediscover

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel • Edited

To the point! 💯 Hopefully, such engineers sooner or later realise that collaboration is a win-win both for tech writers and for devs, even if it takes away a bit of time one could devote to coding 😉

Collapse
 
itskondrat profile image
Mykola Kondratiuk

Worth adding: forcing the knowledge transfer often reveals the engineer didn’t fully have it themselves. Writing it down for a tech writer surfaces gaps in their own understanding. Half the friction isn’t protectiveness — it’s engineers running on pattern-matched intuition with no real spec behind it.

Collapse
 
adamthedeveloper profile image
Adam - The Developer

DEV needs to add a laughing reaction haha

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

Agree 💯! There are plenty of humorous posts on dev.to, would come in handy 😄

Collapse
 
esin87 profile image
Esin Saribudak

I love a Golden Boy (or Golden Girl)! What's the most common archetype you encounter?

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

Fortunately, it's a golden one! 😄 There are many collaborators out there in the tech industry! It happens that engineers admit they don't know how to write good docs, but they are open to collaboration, and together we can create content that is clear and easy to follow.

A bit concerning is the recent trend of generating loads of docs using AI (see: Robot). It can do more harm than good, as extracting useful content from a generated mess is very often more time-consuming than writing a messy but concise draft that tech writers can later use as an input for the docs. This is actually a much bigger topic – maybe even worth a separate article 😄

Collapse
 
0xax profile image
0xAX

maybe even worth a separate article 😄

It is definitely worth!

Thread Thread
 
klaudiagrz profile image
Klaudia Grzondziel

Thank you for your support @0xax ! 💛

Collapse
 
99tools profile image
99Tools

As a developer, I can confirm every team has at least one “Jon Snow” and one “Minimalist” 😄

This was funny, painfully accurate, and honestly a great reminder that good documentation is teamwork.

Collapse
 
klaudiagrz profile image
Klaudia Grzondziel

good documentation is teamwork

Exactly! 💯 That's why it's so good to have golden ones in the team 💛

Some comments may only be visible to logged-in visitors. Sign in to view all comments.