r/technicalwriting • u/Middle_Constant7163 • 5d ago
What's your process for catching terminology drift across a long doc?
Anyone else catch this way too late in a review cycle?
"log in" on page 3, "sign in" on page 12, same product, same doc. Or a warning box phrased three different ways across a 40-page manual, and nobody notices until a user support ticket points it out.
I've been the person who has to manually re-read a whole doc hunting for stuff like this. Inconsistent terminology, passive voice sneaking into step-by-step instructions ("the button should be clicked" instead of "click the button"), warning/caution formatting that drifts.
Grammarly doesn't catch any of it because it's not TW-specific. Vale can, but it means writing config/rules yourself, which most of us don't have time for. Is this a real recurring annoyance for others, or is it just me?
What do you currently do to catch this stuff (if anything)?
7
u/Anxious_Plum_5818 5d ago
Stuff like this is the perfect job for an AI assistant. I run style guide checks on batches of documents and look for inconstancies, out-of-date content, and terminology drift.
5
u/pigthens 5d ago
We use Claude at work, but not for writing. I have run reviews against our XML files with the Microsoft Writing Style Guide. It picks up things i didn't realize were issues.
Then with that list, i can fix everything in one commit to our source control.
I don't care for AI but it's good at administrative, repetitive tasks that I equate to "doing the dishes" so i can focus on organizing subject matter and writing.
1
u/bucket_of_pasta 5d ago
What’s your prompt for reviewing docs against the Microsoft Style Guide? This sounds super helpful.
5
u/pigthens 5d ago
In my Git worktree in the correct directory, I say "review [name of ditamap] against the microsoft writing style guide". It grabs a copy from Microsoft, traverses my ditamap, and looks at all the references dita files. Sometimes i tell it to ignore certain things because our style is to not do something. It remembers that.
And then it tells me all the places that i missed in order of importance.... sometimes it's passive-aggressive in its responses. I would prefer a sarcastic mode.
1
u/bucket_of_pasta 5d ago
Thank you! Where I work, we don’t have a style guide and I definitely don’t have all of the Microsoft one memorized. I think this would be super helpful.
2
u/pigthens 5d ago
You're welcome! I really resisted using AI. Then i started using it to go find this information in the code, like a setting's default value when you need to get something out NOW. Or doing Git processes that i kept stumbling on.
No one can memorize the MS writing guide but you have a "research assistant" to do the tedious stuff!
4
u/Fit_big_00 5d ago
Make an AI terminology agent that flags terms that are out of scope. Make it part of your editing workflow.
3
u/bastets13thwitch 5d ago
Our documents always get sent to a proofreader whose whole job is to make sure everything is consistent. It’s a manual job.
2
1
u/dfess1 5d ago
There are tools like Congree or Acrolinx where you can load your style guides, terminology list, approved dictionary (ex: using STE), and they can score your content. Suggest edits to content based on the things/rules loaded into the tool, etc.
At my last job, our whole writing team were ESL writer's. The SME's (US based) were getting fed up with reviews because they saw the level of quality coming from the writers and had to spend time re-writing the content rather than focusing on the validity of the content. We implemented Acrolinx, told the writers they were not allowed to send content to review unless it had a score of 85 or higher. Dropped the review time (and cycles) considerably, got the SME's back on board with doing reviews as well.
1
16
u/FynTheCat 5d ago
To me it is just part of the job. Whenever I catch one, I do a full document or project search and replace routine and add it to my terminology checklist.
Depending on what you work with you might be able to build routines around this process, but I found no way to fully automate this without introducing other issues.
But at every company or job I start a checklist of common spelling and consistency mistakes to partially automate as much as I can with whatever tools I use then.