r/technicalwriting • u/Extreme-Secretary596 • 1d ago
r/technicalwriting • u/Contentandcoffee • 2d ago
SEEKING SUPPORT OR ADVICE Vibe-coded AI slop examples
reddit.comr/technicalwriting • u/jhansen123_reddit • 2d ago
Include or omit comma before company form designations such as LLC, LP, Inc., PC, and so forth?
reddit.comr/technicalwriting • u/chimp-chaanakya • 2d ago
JOB Transitioning from SaaS to Aeronautics/Machinery with a BA in English , is a technical degree mandatory?
I have 2 years of experience as a technical writer at a product-based SaaS company, with a MA in English.
I’m looking to pivot into hardware-heavy fields like aeronautics, machinery, or automotive, but almost every job posting lists an engineering or technical degree as a mandatory requirement.
For those in these industries:
- Is a STEM degree a hard filter, or can strong documentation skills and structured authoring (DITA/XML) get me past HR?
- Are there specific standards (like S1000D) or certifications I should learn on my own to bridge the gap?
r/technicalwriting • u/BenchPressAddict • 3d ago
Tech writing vs Quality documentation
Reading this subreddit is making me pessimistic about learning technical writing. I'm about the graduate from a material science/chemistry bachelor and I want to learn a skill to work remotely.
How would quality documentation of work instructions, document control, declarations and measurement reports fare in comparison with standard technical writing? Or is this also a branch that is dying out? If you have any experience in this branche I'd love to hear about it.
r/technicalwriting • u/Neko_shii • 3d ago
CAREER ADVICE Is Technical Writing a career path worth pursuing?
Hello! I'm a mid-20s individual struggling to find a career path to pursue. I recently went through a situation where someone I know asked me for help on a project. I happened to have the specific skill they needed, so I took the time to create a road map for them on how to handle these task. After I finished, I sent it to them and never thought of it again.
After they finished their project, they came back to me and said that the road map helped them significantly. They even said (as a joke) that the road map felt like it was holding their hand the entire time because of how much information it provided. Overall, they really appreciated my help and managed to summit their project on time.
After receiving their feedback, I felt pretty good about myself for something I find pretty natural to do.
This situation gave me the inspiration of a possible career path. I did some researching and discovered Technical Writing (TW). TW is definitely up my alley and something that I could potentially strive for.
Of course, I do have my worries about this path. I worry that it's something that AI could easily take over, or that it's an industry that's over saturated.
So if anyone can kindly provide their thoughts and opinions on this matter, I would very much appreciate it.
Edit: Hello everyone! I really appreciate all the responses/advise, and thank you to the people sharing their personal experience. I'm definitely not feeling discouraged, if anything reading all the comments are making me think more of other possibilities. Good thing I only recently started researching on this, so not much time has been wasted
r/technicalwriting • u/Sun_of_Land • 3d ago
Looking for a Technical Writer who loves Engineering. Build, Document & Design Real-World Software
reddit.comr/technicalwriting • u/Two_wheels_2112 • 3d ago
SEEKING SUPPORT OR ADVICE TW contractors: errors and omissions insurance?
I'm doing some TW work on contract for the manufacturing company I recently retired from. It's a short-term gig to get InDesign-based docs into DITA.
Their products are safety-critical and lawsuits do occasionally happen. Rarely because of anything in the technical documentation (it usually gets them out of trouble) but it's not impossible to imagine a scenario where an error in assembly or operating instructions could result in property damage, injury, or worse.
I'm going to request an indemnification clause that would say that my work product is subject to technical and compliance review and approval, and therefore the company is responsible for any errors. Do you think this is enough, or should I be looking at errors and omissions insurance?
Or is there some other way you deal with this that I'm not thinking of?
r/technicalwriting • u/Immediate-Homework55 • 3d ago
RESOURCE I've been building a Mac app that turns a screen recording into a step-by-step guide. Would love feedback
Hey everyone!
Lately I've been working on Steppr – https://getsteppr.com
You do a task once and talk through it. Steppr captures a screenshot for every click, highlights it, and transcribes each step from your narration. You can edit and annotate screenshots with arrows and boxes, blur screenshots, and export to PDF, HTML, video, or Markdown.
It's Mac-only. No account, no cloud, no subscription. 7-day free trial, then $9.99 one-time payment.
Note: it isn't notarized yet. If macOS blocks it, go to System Settings > Privacy & Security > "Open Anyway".
I'd appreciate your feedback on what feels clunky or missing, and other use cases you might have for Steppr. Thank you!
r/technicalwriting • u/King_Wolf_- • 4d ago
SEEKING SUPPORT OR ADVICE Where to start Writing
Hi everyone, i’m not proficient in english, and I have an engineering job that involves technical writing (Basically describing what has happened in the analysis. This report includes the usual which are introduction, results, summary etc. Results sometimes composes of table datas, but most of the time discribing a specific phenomenon)
Similar to a technical research maybe
What books do you recommend that teaches this in a very easy and understandable way? All books i have related to grammar the examples are mostly for conversations
THANK YOU
r/technicalwriting • u/screamingurethras • 4d ago
QUESTION Any madcap users also integrating AI?
Working in a government space. We have been using Madcap Flare for years and it’s hugely beneficial to our workflows. However, our company recently acquired a version of Claude that we can use with our government work.
My manager is constantly pushing for AI use and wanting to see more. I am doing what I can but it is not enough for him. We can use it for minor things - peer reviews, acronyms, initial draft for new processes, etc. but I’m a bit at a loss how we are supposed to use in a more impactful way that management wants to see. Our most tedious processes are trying to get SME input and I don’t really see AI introducing a way around that. Using the AI option within flare is also not an option for security reasons.
Has anyone else found ways to incorporate AI into their madcap workflows? Or honestly - how are people using it in general? I imagine it will help with draft creation but flare is already a big portion of that and the database of content we keep there is not replaceable/replicable through AI. And if you have found huge time savings - was your goal also to just get more work coming your way to make up the time? This is giving me such anxiety, I’m trying to be proactive. Thank you!
r/technicalwriting • u/Jazzlike_Page508 • 5d ago
QUESTION How to become a technical writer with out necessary experience in todays climate?
Hiyoo
So I have a bachelors in communication, masters in public administration, and I am currently earning my ABA paralegal cert from Villanova
But I’m curious on how to become a technical writer? I went on indeed and I saw that pretty much all of the job postings leaned heavily on STEM field but scouring through this subreddit I found that pretty much anyone can become one.
Where would I look to find entry level jobs? I recently went on Google and found several websites and I went through the process only to find that there was a paywall to advance any further.
So I’m stuck in between a rock and a hard place. How does one become a technical writer? How can I become an entry level technical writer as I have no experience, and what are some good websites to look at job postings?
Bonus: what necessary skills do you think I’ll need? Remember since I’d be entry level I’m just going in with what I have but I’m not sure it’s anything relating to the field
r/technicalwriting • u/noiseknowledge • 5d ago
Portfolio Review
Hi everyone,
I am looking to get my portfolio reviewed. I tried asking Write the Docs on Slack, but no one replied to my request so I eventually deleted my comment.
Is there anyone here who could look at my portfolio and give me some tough feedback?
Thank you.
r/technicalwriting • u/filip_gl • 6d ago
How do you keep your how-to docs and SOPs from going stale?
Where do your processes live (a wiki, Confluence, Google Docs, videos)? Who's responsible for them, and what happens when the software changes and half the screenshots are suddenly stale or plain wrong? Does somebody fix them, or does everyone just ask in Teams or Slack when they're stuck or find something that's clearly outdated.
I'm building something, or rather have built something in this space so I'm quite biased and going solely from my own experience or past struggles, but I'd rather hear how it actually goes for you folks than guess. Or I suppose I'd want to know what your pain points are and what would make this process easier for you.
r/technicalwriting • u/InternationalGap3698 • 8d ago
Is "80% of the way to ASD-STE100" a useful target for cleaning up AI-written docs?
Andrej Karpathy suggested asking LLMs to write "80% of the way to ASD-STE100" to get clearer output. I wanted to see how far that idea goes, so I built a small open-source skill for AI coding tools (Claude Code, Codex, Cursor) that rewrites text in two passes:
- Remove common AI tells (based on Wikipedia's "Signs of AI writing")
- Rewrite in an STE-inspired style: short sentences, one idea per sentence, active voice, no filler
It does **not** enforce the full STE dictionary or the approved-word list. That's the "80%" part.
**Before:** "Great question! Kubernetes liveness probes are a powerful mechanism that enables the kubelet to determine whether a container is healthy — and it's not just a health check, it's your first line of defense…"
**After:** "A liveness probe tells the kubelet if a container is healthy. If the probe fails, the kubelet restarts the container."
My questions for people who actually work with STE or controlled language:
- Which STE rules matter most for readability outside aerospace?
- Which rules would you drop for software docs?
- Is "partial STE" useful, or does it miss the point?
Repo (MIT) if you want to look at the rules I used: [Dodaios/ste80-humanizer](https://github.com/Dodaios/ste80-humanizer)
r/technicalwriting • u/WontArnett • 10d ago
POLL Just for fun, let’s do a poll!
Are you an experienced technical writer that’s currently employed?
Or are you currently unable to leverage that experience into an employment situation?
Let’s see how everyone is doing in this lovely job market!
r/technicalwriting • u/Key-Prompt7936 • 10d ago
QUESTION Technical Writing meetups in SF next week
Does anyone know of any meetups or technical writing events in SF next week?
I have never been to San Francisco before, and I am planning my first trip next week.
I am planning to go there on vacation after months of job hunting (220+ applications) and also check out the WtD meetup.
But are there any other technical writing (or adjacent events) I could go to meet fellow technical writers?
r/technicalwriting • u/ChairmanMrrow • 11d ago
QUESTION Technical writing beyond software
How many members of this sub work on something other than software?
ETA- Most of my experience has been in tools, fasteners, and pumps.
ETA- Writing manuals was my favorite part of my last job.
Edit 11/13: I appreciate the responses. It's interesting to learn about all the different kinds of technical writing one can do.
r/technicalwriting • u/marchenland • 11d ago
QUESTION Images with callouts
I want to pick your brains about images / screenshots.
Do you use them? Do you use callouts such as circled sections, numbers, and lines? What programs do you use to create them? Do you maintain source files or do you make new ones every time? How do you handle consistency such as making sure that all your lines have the same line weight and numbers / letters use the same size font? Do you have any other issues or solutions for improving workflow for maintaining these things? If you could design a tool to improve your experiences with images, what would it do?
r/technicalwriting • u/Superb-Bluebird4648 • 12d ago
Holy Heck is Paligo's Nexus Bad
So, my manager has decided to explore Paligo's Nexus tool. And as bad as their UI and workflow are for normal publication flows, this thing has managed to accomplish something I would have thought impossible: it's somehow worse.
The first problem is their theme tool. It's supposed to be a VS Code plugin that claims "For an edit loop without uploading, the Paligo Theme Studio extension for VS Code renders a theme folder against a real publication as you save." Except that description bears almost no resemblance to what it actually does.
Paligo hands you a folder full of Twig, CSS, and JS, then tells you it’s a “theme” as if you’re building a normal front-end app. In reality, you’re packaging a server-rendered publication template, uploading it to their platform, and then waiting for their backend to reassemble the whole docs site with your design bolted on. It’s not “live preview” in any meaningful sense. It's a long, fragile chain of packaging, uploading, and rendering. That's not a theme. It’s a hostage note to a render pipeline.
And the “customization” isn't a theme layer either. It's a late-stage JS patch job: the page is rendered by the platform, then the client-side script injects the branded content, images, and structure at runtime. The “customized” experience is not actually the template: it's an assembly that occurs in the browser after the fact. What's really happening is that they're shoveling brand assets, nav chrome, and layout bits in via JavaScript when a page loads. Their marketing text is an overly elegant way to describe a system that is, under the hood, rendering a shell and then layering the “real” design on top with script, like too much makeup trying to cover the ugly underneath.
Each render takes over three minutes (yes, I timed it) so if you want to tweak an element and see what changed, that's a three-minute wait... each time. Color not quite right? Three minutes before you can see if your change worked. Font size a little too small? Three minutes before it renders with new headings. Logo cropped funny? Three minutes before you can see if your edit fixed it. Every time, the platform has to repackage the bundle, upload it, validate it, and re-render the publication on the server before you can even see whether a change did anything useful. That is not “live editing.” My smallish sample taking three minutes is a reminder that what's really happening with every edit is a server-side deployment with a side of disappointment.
r/technicalwriting • u/Loose_Blackberry1146 • 13d ago
College Undergrad Looking to Freelance
So I'm an undergrad in Electronics and Communication Engineering. I am a beginner at most things. I've only got C fundamentals for now and I'm trying to learn Linux and further get into robotics. But I have some writing experience(nothing professional and nothing specifically tech-related). I wanna pursue freelance tech writing as an immediate professional goal but I have no idea what to do for now. Where should I even look for it? How to build a profile, proof of work? And how to get monetised?
P. S. I'm open to online, remote work, preferably from established dev platforms.
r/technicalwriting • u/Consistent-Branch-55 • 14d ago
Dear vendors
I can say that the way you act in this sub has turned me off of at least 3-4 of you. I don't think we need some kind of moderation, but you guys really need to think more carefully about engaging here. With love, someone who has considered vendors in the past and will consider vendors again.
r/technicalwriting • u/PoppyDaily • 14d ago
SEEKING SUPPORT OR ADVICE Where to look?
I am in need of someone to help me document personal messages for court evidence. The conversation is between two parties newly co-parenting. This is a complex matter with sensitive family topics. The goal is to spotlight certain patterns of behavior. Does anybody know where to find this type of writer or documenter?
r/technicalwriting • u/Ornery-One6584 • 15d ago
Doc as Code, I'm getting replaced. Advice?
Just found out that my company has tied AI into the source code of our software suite and no longer need a technical writer to write user guided documentation. The docs are soo accurate, they can copy and paste to the knowledge base and even automate dev work and SME reviews into the solution...
Anyone encounter this? Is there a future left in this industry? Are people adapting? How can I seque my skills for the next role, if there is one..
Any comments would be much appreciated, thanks guys -