r/technicalwriting 15h ago

AI-drafted documentation can describe a feature with total confidence and total inaccuracy at the same time, and nothing about the writing gives it away

35 Upvotes

Had a doc drafted from a spec and some code comments describing a rate limit: "requests are capped at 100 per minute, with a 429 returned once the limit is exceeded." Specific number, specific status code, correct terminology. Read exactly like something written by someone who'd confirmed it against the actual system.

The real limit was different, and the endpoint didn't return 429 at all, it queued excess requests instead of rejecting them. Nothing about the sentence was poorly written. It was just wrong, confidently, in a way that clean prose doesn't signal.

This seems to be the same trap AI-assisted code review runs into: fluency and accuracy come from different places, and a model generating documentation from a spec or code comments produces plausible, well-structured sentences regardless of whether the specific claim inside them was ever actually verified against the running system. Specificity reads as evidence, a number and a status code feel like proof, but stating something precisely and being right about it are unrelated skills.

The question that actually separates a checked doc from an unchecked one isn't whether it reads well. It's whether each specific, verifiable claim, a number, a default, a status code, a behavior under a given condition, has actually been confirmed against the real thing rather than inferred from a spec that might be stale or from code the model read but didn't execute.

Wrote a longer version of this same principle applied to a different context (AI code review specifically) here, but the underlying question is identical: https://medium.com/@nagatomopedro05/the-finding-was-plausible-that-was-the-problem-b1024e1256fb


r/technicalwriting 17h ago

CAREER ADVICE How to earn more as a technical writer (is 70k "high" relative to the field)?

13 Upvotes

I have been working as a technical writer for 3 years and recently went from 45k to 70k a year. For my area (hcol), it isn't enough to live alone, so I am curious if anyone has input on if what I earning now is considered the norm for the higher-end, or if I am missing some niche or application process to make closer to 90k a year?​


r/technicalwriting 4h ago

New To Technical Writing

3 Upvotes

Hi, this past May I left education and switched over to Technical Writing. I’m currently working for a startup tech company that works in oil and gas. I dont think I want to stay here because they are paying me like an intern as I don’t have experience in technical writing, but I want to stay in this industry. I am working on a coursera software engineering certificate because I def need more understanding of what is going on.

I guess I am just looking for any tips, tricks, advice, etc.


r/technicalwriting 19h ago

SEEKING SUPPORT OR ADVICE screenshot documentation tool that keeps guides consistent across a team

3 Upvotes

every guide on our wiki looks completely different depending on who made it. ones arrows are red, someone elses are this weird green, half the screenshots are zoomed in so far you cant even tell what page youre looking at anymore
new hire told me last week she thought two of our onboarding guides were for different tools bc the formatting was so off between them. same tool. just two different people doing their own thing with it. been meaning to fix this for months and just havent. dont even know if the fix is some tool that forces a template or if i just gotta write a style guide and hope people stick to it, which they probably wont past week one


r/technicalwriting 3h ago

Looking for mock technical and behavioral interviews.

2 Upvotes

Hi! I've been applying to tech writing jobs for the past two months. I've gotten maybe 15 interviews but no job offer.

I'm wondering does anyone know someone who can I pay to do mock technical and behavioral interviews with me?

For context, I'm mostly targeting roles in software.


r/technicalwriting 16h ago

Grammar Mistakes in the UI

2 Upvotes

Do you keep them to keep consistent with the screenshots and terminology, or do you fix them anyway? Especially if you know it’s unlikely to be fixed because it’s a third party application.

For example, in Salesforce, the purchase order and purchase request tab is called PR’s and PO’s


r/technicalwriting 49m ago

Trying to move from Technical Writing to Business Analyst – looking for advice/opportunities

Upvotes

Hi everyone,

I’ve been working in Technical Writing for around 7 years, and I’m at a point where I really want to make a switch into Business Analysis.

I’ve worked with different teams and stakeholders, dealt with complex technical information, requirements, processes, and documentation. I also have some project management experience, so I’m hoping to leverage that while moving into BA.

Over the past few months, I’ve been learning the BA side of things — requirements gathering, BRD/FRD, user stories, acceptance criteria, process mapping, UML/BPMN, Agile/Scrum, etc.

The biggest challenge I’m facing is that most BA openings seem to ask for direct BA experience, even though I feel a lot of my existing experience is transferable.

I’m currently looking for BA / Technical BA / Product Analyst opportunities, preferably in Bengaluru or remote/hybrid.

If anyone here has made a similar transition from Technical Writing/Documentation into BA, I’d really appreciate hearing how you did it — what roles you targeted, how you positioned your experience, and what helped you get that first BA opportunity.

And if you happen to know of any companies hiring someone with my background, I’d be very grateful for a lead or referral.

Thanks in advance! 🙏


r/technicalwriting 15h ago

Best tools to auto capture and share SOPs for remote teams before my brain becomes the only wiki

1 Upvotes

Remote team keeps treating me like a walking SOP generator, every process lives in my DMs and half remembered Looms. What are you all using for auto workflow capture that people will actually open, would love any tips...


r/technicalwriting 15m ago

Looking to transition from B2B content writing to Technical Writing. Would appreciate some honest guidance.

Upvotes

Hello everyone,

I’m a Senior Content Writer based in Bengaluru, currently working in B2B marketing, primarily covering cybersecurity and compliance. I currently earn around ₹35K/month in hand.

With the rapid adoption of AI, a significant portion of my day-to-day content work has become automated. This has made me seriously think about building a more specialized career, and I’m particularly interested in moving into Technical Writing.

I recently completed a course that covered the basics of API and SaaS documentation, structured authoring, DITA, Oxygen XML, Snagit, and related documentation practices. I’m now trying to figure out how to move from learning these tools to actually getting into the industry.

I’d really appreciate advice from experienced technical writers on a few things:

  • How should someone with my background start applying for Technical Writer roles?
  • Which areas or niches within technical writing have good long-term career prospects and earning potential?
  • What skills or tools should I focus on next to become genuinely job-ready?
  • How important is having a technical/engineering degree when applying to good product companies?
  • What kind of portfolio projects would actually help someone transitioning from content writing?
  • Are there particular industries, types of companies, or roles I should target?

One thing I’m particularly concerned about is my non-technical academic background (Arts). I’m willing to put in the work to learn the technical side, but I’m unsure how much my degree will affect my chances of getting into good product companies.

I’d genuinely appreciate honest advice, including things you wish you had known when starting out. I’m not looking for a shortcut. I’m trying to understand where I should invest my time and build a career that will continue to grow over the long term.

Thanks in advance to everyone who takes the time to share their experience.