0:00
Welcome to the Technical Writing Success podcast from Kurt Robbins,
0:03
where we help you get smarter than your competition.
0:05
Higher Kurt to coach you or your employees in AI to avoid a pink slip or
0:10
having your competition eat your lunch.
0:11
This is episode 190.
0:13
I am your host, Fred Jones.
0:15
And I am your expert guide, Dacni Blake.
0:17
This episode reviews an informative newsletter from senior technical writer,
0:21
Victoria Olucci Lazarus in Nigeria entitled, the hidden skill every technical
0:26
writer must master those published on February 23.
0:30
And, you know, we're really focusing squarely on your career toolkit today.
0:34
Because we want to explore why mastering grammar or having a deep technical
0:40
understanding of a product or even knowing industry standard tools,
0:43
like notion or mad cap flair, all the standard stuff.
0:47
Why all of that is simply not enough to succeed in technical writing.
0:51
Let's unpack this because Victoria's main argument here is that the real
0:54
job of a technical writer isn't just to, well, document a product.
0:59
The job is to organize reality.
1:00
And let's be honest, reality in the software development world is, uh, it's
1:06
It really is incredibly messy.
1:08
I mean, you have engineers who view the product entirely through the lens of
1:12
the code base, right?
1:14
And then you have product managers focused on business outcomes, plus the end
1:19
users who just want to get a specific task done without pulling their hair out.
1:24
They just want it to work.
1:25
So to navigate that chaotic intersection, you need this invisible capability
1:31
that she calls structured thinking, structured thinking.
1:36
It's basically the ability to take all of that raw, disorganized complexity,
1:40
synthesize it internally and then present it externally as something clear
1:46
But I am going to push back on that phrase a bit because structured thinking
1:50
sounds highly intellectualized.
1:53
Isn't it just a fancy philosophical way of describing formatting?
1:57
I mean, like if I'm applying a strict style guide and organizing my thoughts
2:01
into bullet points, right, making it look nice.
2:04
Have an eye structured by thinking, well, not exactly.
2:07
And that is a really crucial distinction to make formatting is purely
2:10
visual, you know, it happens on the screen, but structured thinking is purely
2:14
It happens in your brain.
2:15
It's like, um, think of it like cartography map making.
2:20
Yeah, formatting is just choosing the color of the highway lines on the
2:24
map or picking a nice font for the city names.
2:27
But structured thinking is the actual surveying of the terrain.
2:32
It's figuring out how the road network connects, determining which paths are
2:35
one way and like understanding where a traveler might get lost.
2:40
So if you draw a beautifully formatted road that leads directly off a cliff,
2:43
the font you chose really doesn't matter.
2:45
The underlying logic is broken.
2:47
That makes perfect sense.
2:49
A beautifully styled document that forces a user to jump back and forth
2:52
between three different pages is still a failure.
2:56
It's a total failure.
2:57
The tools just can't fix a broken thought process.
3:00
What's fascinating here is how applying this mental framework fundamentally
3:04
alters your day to day workflow.
3:07
The article actually highlights three superpowers of this.
3:10
So the first superpower is asking better questions because without structured
3:16
thinking, a writer often falls into the trap of just, you know, asking unstructured
3:20
things like walking up to a lead developer and asking, Hey, how does this new
3:25
authentication feature work exactly, which is a terrible question.
3:30
It really is because the engineer is going to answer you truthfully from their
3:33
perspective, which means they'll give you a highly technical, completely
3:37
disorganized brain dump.
3:39
They'll start talking about how the token hashes through assault bypasses the
3:43
middle where you're just frantically taking notes completely overwhelmed and
3:47
you walk away with a timeline of the code's execution rather than an actual guide
3:53
But a structured thinker doesn't ask that open-ended question.
3:56
They map the context first.
3:58
They asked things like what specific user problem does this feature solve for
4:04
And what needs to happen immediately before the user reaches this step?
4:08
You establish the why and the who before you ever touch the how you're
4:11
essentially interrogating the boundaries of the feature before you let them
4:16
talk about the internal mechanisms.
4:17
Yes, because you're preventing the chaos from entering your notes in the first
4:21
place, which naturally solves one of the biggest frustrations readers face.
4:25
Creating actual flow.
4:28
That's the second super power because as a reader, there is nothing more
4:33
exhausting than reading a paragraph, feeling completely lost and having to
4:38
reread it three times just to decipher the basic context.
4:41
That friction happens because the writer didn't provide a mental anchor.
4:45
They just dump facts onto the page.
4:47
But when you structure your thinking, the reader never has to guess the next
4:52
It's the difference between being handed a box of puzzle pieces with no
4:57
picture on the cover versus being handed the pieces already sorted by color and
5:02
That's a great way to put it.
5:03
You did the heavy lifting in your brain.
5:05
So there's doesn't have to struggle.
5:06
But this brings up a delicate tightrope lock.
5:09
You're constantly tasked with explaining highly complex systems.
5:13
How does this help you break down complexity without oversimplifying it?
5:17
Because that's the third super power, like handling complexity.
5:21
And it allows you to control the altitude of the information.
5:25
You don't start at ground level in the weeds of the code.
5:27
You started at 30,000 feet exactly to establish the broad landscape.
5:32
What the system is and why it exists.
5:35
Then you methodically drill down.
5:37
You show the relationships between different pieces before you explain the
5:42
You aren't just transcribing facts.
5:44
You are actively designing, understanding, designing, understanding.
5:48
Let's take a brief break for a special message from our producer, Kurt Robbins.
5:52
Hi, this is Kurt Robbins.
5:54
First, thanks for listening.
5:55
I truly appreciate your support.
5:57
I want to let you know that I'm currently accepting new clients.
6:00
My rates are affordable and I have more than 25 years of experience working
6:05
for enterprise companies like Microsoft, Northrop Grumman, Oracle, PNC bank,
6:10
FedEx, USA and Wells Fargo, among many others.
6:14
If you want to improve your IT documentation and communications, hire me.
6:19
Know how to use AI to improve efficiency and accuracy and love going the
6:23
extra mile to satisfy my clients.
6:25
Thank you for subscribing and listening.
6:28
Back to you, Daphne and Fred.
6:29
Welcome back to the technical writing success podcast, where we help you get
6:33
smarter than your competition by coaching you in AI.
6:36
Thanks for staying with us.
6:37
So what does this all mean for you listening right now?
6:40
If you sit down at your desk tomorrow morning to document a messy new API,
6:44
what is the practical application of this?
6:47
Well, the most critical step is building a mental blueprint before your
6:50
hands ever touch the keyboard.
6:52
You have to violently resist the urge to just open a blank page and start
6:56
typing chronological steps.
6:58
Because chronological doesn't always mean logical, absolutely not just because
7:02
a developer built the feature in a certain sequence doesn't mean a human
7:05
brain wants to learn it in that sequence.
7:08
So to build this blueprint, you interrogate the info you have.
7:13
You start by strictly defining the primary objective.
7:16
If the user only takes away one thing, what is it?
7:19
Then you determine the absolute prerequisites like what must they have already
7:24
installed before step one even makes sense?
7:26
This is how you spot those catastrophic gaps in logic.
7:30
If you're just typing out steps blindly, you're going to miss things.
7:33
But with a blueprint, you suddenly realize, wait, step four requires a unique
7:37
ID, but we haven't actually explained where to find that ID.
7:41
And you catch that inconsistency while it's still just a thought rather than a
7:44
publish error that generates 10 angry support tickets.
7:48
Did Victoria share any specific tips for strengthening this skill?
7:53
A great practical exercise is to take dense, existing paragraphs of
7:57
technical explanation and ruthlessly convert them into clean bullet hierarchies.
8:02
Oh, I find that exercise fascinating because it exposes terrible writing
8:09
When you try to force a meandering paragraph into a strict hierarchy,
8:13
the fluffy, unnecessary text has nowhere to hide.
8:16
You realize half the paragraph was just filler.
8:19
It's a phenomenal diagnostic tool.
8:21
But the ultimate test of structured thinking, and she highly recommends
8:25
trying this is practicing layered summarization, layered
8:30
It's taking a complex technical concept and explaining it in three distinct
8:34
layers, beginner, intermediate, and advanced.
8:37
Oh, let's actually put that to the test right now.
8:40
Let's take a standard concept like an API key.
8:43
So if I am a complete beginner, say a non technical project manager,
8:47
how do you structure that for a beginner, I'm omitting the technical
8:51
mechanism entirely, I'd say an API key is like a digital ID badge for an
8:56
When your software tries to get data, it swipes this badge to prove it has
9:00
the right security clearance.
9:02
You anchored it to a real world concept, intermediate layer.
9:06
I'm a junior developer.
9:07
I know what APIs are, but I need practical context.
9:10
We introduced the mechanics without the edge cases.
9:13
An API key is unique string passed in the header of a request.
9:17
It authenticates the client without needing a password every time.
9:20
Mostly to track usage and prevent abuse.
9:23
Notice how the structure shifted from analogy to functional mechanics, right?
9:27
Okay, hit me with the advanced layer.
9:28
I am a senior backend architect integrating our enterprise system with yours.
9:32
Now we focus entirely on constraints and security.
9:35
Our API keys are cryptographically generated UUIDs tied to specific permissions
9:40
You pass them via a bearer token over TLS 1.2.
9:44
They have a 90 day rotation policy and rate limiting is enforced at 10,000 requests
9:51
The topic never changed, but the structural architecture completely adapted
9:55
to my cognitive needs.
9:56
If you can do that fluidly, it means you own the information.
10:00
It doesn't own you that adaptability is amazing.
10:02
If we connect this to the bigger picture, there was this truly
10:05
profound comment on the original newsletter from a reader named a manual.
10:11
What did a manual say?
10:12
He pointed out that technical writing is essentially the vital load bearing
10:16
bridge between raw, intimidating complexity and everyday usability.
10:21
I love that visualization because a product could have the most elegant bug free
10:25
code base in the world.
10:27
But if the bridge connecting that code to the user is structurally unsound,
10:31
right, if the docs are chaotic, the user will never experience that
10:35
They'll just experience frustration and abandon the product.
10:39
The engineering of the product and the engineering of the explanation are equally
10:42
important, which makes it incredibly ironic that this
10:45
skill goes almost completely unrecognized.
10:48
It is the ultimate invisible skill.
10:50
I mean, no user is ever going to email you saying, wow, the cognitive
10:54
mapping of this manual was exquisite and you're rarely going to see structured
10:59
thinking listed as a mandatory requirement on a job description.
11:03
Recruiters just ask for five years of experience with markdown or get
11:06
because tools are easy to measure.
11:08
You either know Jira or you don't, right?
11:11
It's much harder to measure someone's ability to impose order on chaos.
11:15
But the tools are just the paint.
11:17
Structured thinking is the framing of the house exactly.
11:20
And because it's invisible, it's drastically undervalued by writers
11:23
themselves, which is a massive career mistake.
11:26
The technical writing is about thinking clearly enough that others don't
11:30
It really forces us to ask a much larger question.
11:33
We spend so much time optimizing our software stacks and tweaking our style
11:38
But what other invisible cognitive skills in your daily workflow?
11:42
Are you currently undervaluing that actually dictate your success?
11:45
That's the real question.
11:47
Thank you for listening to the technical writing success podcast from Kurt
11:50
Robbins, where we help you get smarter than your competition.
11:53
Hire us to coach you or your employees in AI to future proof your career or
11:59
Subscribe now to never miss a career saving episode.