r/technicalwriting101 • u/MisterTechWriter • May 08 '24
r/technicalwriting101 • u/MisterTechWriter • Jun 10 '24
RESOURCE Characteristics of Technical Writers
I love to learn about how things work.
I'm good at giving directions. (Now, if only people would follow them.)
I like to teach people and explain how to do things.
I enjoy language and words.
I'm very aware of grammatical errors and typos.
I'm able to work well with many different types of people.
I'm flexible. If something has to change, I can accept it as part of the job.
I pay attention to details.
I'm able to keep track of many things at the same time.
I know tech writing is not meant to be personal expression, so I won't take it badly if someone edits my brilliant prose.
From Krista Van Laan's "The Insider's Guide to Technical Writing"
r/technicalwriting101 • u/NullOfficer • Apr 13 '23
FINDING WORK Warning for job applicants: BlueSky (or BluSky) Technologies
Please beware of bad actors when applying for jobs. A company calling itself BlueSky Technologies (and misspelling it as BluSky in emails) is on the Socials offering a Tech Writing job. It would be interesting to datamine the email to see if it's just reused for different companies and positions and just replaces the proper nouns.
NOTE/DISCLAIMER: There are several companies with similar or identical names. These may be authentic companies. The company in question gave no details about who they are.
I was offered a role after submitting and filling out a poorly written and formatted questionaire. Others in other TW subreddits have too. The questionnaire was so ridiculous, it would make a good assignment for freshman year TW students to edit and format to a usabile state.
It's a scam. I don't know how it works, but the company and recruiter don't seem to exist and they want to pay you via wire transfer and have you buy equipment and reimburse. On top of that I don't even know what the company does or sells.
Anyway...in general, please beware.
r/technicalwriting101 • u/[deleted] • Jun 24 '23
TOOLS Templates/Guides for Knowledge Bases?
Hello all,
I'm new to technical writing and want to do medical/science writing primarily. I'm currently working on an independent project for a mental health app to get a feel of how this goes. Any suggestions for templates or guides on writing a knowledge base? I'm taking a course simultaneously but it does not cover these subjects as thoroughly as I'd like. Specifically, I'd like to know what sources or objectives a knowledge base for a mental health app should contain.
Thanks!
r/technicalwriting101 • u/International-Ad1486 • Mar 22 '23
AMA this Friday with Technical Writer Alan Mach!
THANK YOU, ALAN! THIS WAS FUN AND INFORMATIVE.
WE'LL DO IT AGAIN SOON!
-- Bobby
Join us Friday, March 24 at 2pm EST (USA)Time in Your Time Zone
for an AMA with Alan Mach (here, via comments).
About Alan
Alan Mach has worked in software development and production for the past fifteen years. He's been a CG artist, Entrepreneur, and now a Technical Writer. Currently, he works as a Technical Writer at a software development company that creates computer graphics for the world's largest movies and games.

r/technicalwriting101 • u/developeradvacado • Apr 04 '24
RESOURCE Various job titles for technical writers
I have this running .json with job titles related to technical writers, in case anyone is job searching or wants to see what's out there.
If you have any suggestions, feel free to fork and submit a PR-- or drop some here in the thread and I will update this. I grabbed as many as I could think of and landed on about 70.
https://github.com/hectorbarquero/technical-writer-names/blob/main/names.json
r/technicalwriting101 • u/International-Ad1486 • Mar 14 '23
Welcome to Technicalwriting101 !
There's an active subreddit r/technicalwriting that sees the same questions from the "tech writing curious," despite a number of pinned posts covering many issues for newbies.
So this is a place to ask away, pinned posts or not!
Cheers,
Bobby
r/technicalwriting101 • u/MisterTechWriter • Jul 15 '26
Who wants to moderate this sub?
Ladies and gents,
Due to my retirement, I'm withdrawing from tech writing related stuff.
If you'd like to assume the moderation of this sub, please message me.
Thanks!
Bobby Kennedy
Longtime TW, now retired ;-)
r/technicalwriting101 • u/International-Ad1486 • Jun 11 '23
Old man tale You too can post!!!!
Dear 101ers,
This forum is not focused on an old salt with over 20 years' experience as a tech writer (moi).
This forum is focused on YOU, the newcomer to technical writing. Fortunately, I'm not the only old salt frequenting this forum, so you (usually) don't have to hear from me alone.
So don't be shy. ASK AWAY!
Bobby Kennedy
r/technicalwriting101 • u/International-Ad1486 • Apr 03 '23
AMA this Wednesday (2-4PM NYC time) with 20-Year Technical Writer Timothy McMackin!
THANKS TIM! A GREAT EXERCISE.
Tim's Bio
I've always loved writing but didn't want to write fiction, so I didn't know about how to make writing a career until I took a college class in creative nonfiction and learned that there are many careers open to people who can write clearly.
I got my first real job in copywriting for industrial advertising, which introduced me to understanding what info the audience needs to know and how to communicate it to them. I went into a master's program in professional writing and planned to stay in business communication and advertising, but the market was really struggling after the dot-com recession of the early 2000s. Then I discovered software documentation, which captured my interest because I've always enjoyed coding and playing with computers. I had a rough software doc co-op as part of my program that taught me how important it is to find a fit with your co-workers and how you want to work, but I stuck with software doc.
I got a job as a tech writer at IBM thanks in part to connections from the master's program. IBM was great for my career because I got to work with lots of different technologies in a department with about 100 writers of all experience levels. For a while I specialized in docs for programming languages, then cloud provisioning software, and then continuous delivery/continuous integration software. I got to be a team lead, which made me responsible for dividing the work among the team members and making sure everybody knew what they were working on and that no work fell through the cracks.
After 13 years at IBM, I wanted more independence. Through social media I found a job as ShutterStock's first technical writer, which meant trying to change the culture to encourage more information sharing. I did a lot of API and SDK documentation and had a lot of opportunities to code my own doc publishing and platforms. Then the company laid me off in December of 2022. Since then I've been doing a little contract work, but I'm pretty new to contracting and may not be able to answer many questions about contract/freelance work.
My resume and portfolio site is here: https://timothymcmack.in/
Aside from my work, I love kite flying and kite-surfing, cooking, origami, onewheel riding, and theater. Here's my kite collection: https://timothymcmackin.github.io/kite-site/
PS: I'm looking for a full-time job, so let me know of any remote opportunities for senior/lead tech writers that might be a good fit for for me.
r/technicalwriting101 • u/TamingYourTech • Jul 25 '23
WARNING - Kapstone Technologies Inc. phishing scam
old.reddit.comr/technicalwriting101 • u/International-Ad1486 • Apr 21 '23
FINDING WORK Cal Newport: ChatGPT is almost certainly not going to take your job.
ChatGPT is almost certainly not going to take your job. Once you understand how it works, it becomes clear that ChatGPT’s functionality is crudely reducible to the following: it can write grammatically-correct text about an arbitrary combination of known subjects in an arbitrary combination of known styles, where “known” means it encountered it sufficiently many times in its training data. This ability can produce impressive chat transcripts that spread virally on Twitter, but it’s not useful enough to disrupt most existing jobs. The bulk of the writing that knowledge workers actually perform tends to involve bespoke information about their specific organization and field. ChatGPT can write a funny poem about a peanut butter sandwich, but it doesn’t know how to write an effective email to the Dean’s office at my university with a subtle question about our hiring policies.
SOURCE:
r/technicalwriting101 • u/International-Ad1486 • Apr 20 '23
We've reached 500 members in a few weeks!
r/technicalwriting101 • u/MisterTechWriter • Jun 20 '24
Does anyone use Git for their personal writing?
I write fiction -- short stories mostly.
I'm thinking about migrating it entirely to Git.
(Away from MS Word in a folder synced to Apple's icloud)
Has anyone migrated their non-professional work to Git?
Curious to see how it's going.
Bobby
r/technicalwriting101 • u/International-Ad1486 • Jan 06 '24
INSTRUCTION Write and help new technical writers
I'd like to consolidate information found in r/technicalwriting in a series of ONE PAGE Google Docs for r/technicalwriting101.
SOME SUGGESTED TOPICS:
How to create a portfolio
How to interview as a new tech writer
How to work as a software technical writer
(You can scan r/technicalwriting for plenty of others).
STEPS:
Choose a topic. Comment below if you're not confident it's relevant for newbs.
Write it up, using r/technicalwriting for source material (you can add to it if you want, but there's already much info available).
Keep it brief. Preferably ONE PAGE.
Chat the link to me.
I'll review and chat back with recommendations.
Post it (I'll create a sticky post with links to these docs.)
Take credit and add it to your portfolio. ;-)
Here's a starter template (just copy this to create your own).
https://docs.google.com/document/d/1PEYu1OfVXeg4XYOer3kWgWbVhtFH3aFG25Vrtz8v5F0/edit?usp=sharing
r/technicalwriting101 • u/International-Ad1486 • May 25 '23
Old man tale How to become the BEST technical writer?
How to become the BEST technical writer?
So you've decided on a specific path as a technical writer. And you've chosen API documentation. You've completed some crazy good API documentation. You're praised by developers and told you're one-of-a-kind.
You soon suspect you might be one of the best API tech writers in the world.
Or you take another path: You code in Python like a developer. And you write documentation. You're told nobody's been able to show mastery in both like you have.
You suspect you might be one of the best developer-tech writers in the world.
Yet another path. You're not tech adverse, but you're not a coder. Your background is diverse and shows your eagerness to "get up to speed" quickly with different technologies and industries.
You don't know if you're one of the greatest technical writers in the world, but you're confident in your abilities and seem to adapt well to each position.
Question: Which is the better path?
Answer: Who knows? But one answer might be: the one that makes you more employable.
[old man tale]
I managed to stay employed as a technical writer for two decades because I remained a generalist. I was supporting a family of four and didn't have much choice. If I had specialized in an area like finance and worked on Wall Street, I might have been one of the colleagues terminated en masse in 2008. They either went to work at Home Depot for a fraction of their salary or stayed unemployed for many months.
Ironically, I was on a long-term contract that was already funded (as most contracts are).
[/end old man tale]
Now I admire technical skill and its usefulness for a technical writer. I am hardly an advocate for ignorance.
But when I see the FAANG layoffs of people who've referred to non-enterprise software technical writers as "traditional technical writers" or "basic technical writers" I do chuckle inside.
Enterprise software technical writers enjoy the best prestige and pay of any technical writer. But prestige and pay do not mean their jobs are more difficult or demanding.
For that, they can work in a software startup. ;-)
r/technicalwriting101 • u/International-Ad1486 • Apr 06 '23
WOW! -- look at all these Technical Writing resources! - (please upvote)
self.technicalwritingr/technicalwriting101 • u/[deleted] • Apr 15 '25
Name & Shame: Everi
Beware of a company called Everi (make gambling stuff). They have let numerous experienced and very good tech writers go for the ridiculous and unprofessional reason of "bad fit." So you're let go for non-performance reasons that you can't figure out. One day you have a job...no negative feedback...the next day, you're fired for "bad fit."
r/technicalwriting101 • u/International-Ad1486 • Aug 15 '24
Free new API course
https://academy.postman.com/postman-api-fundamentals-student-expert-certification-1
No affiliation.
And it’s free!
Bobby
r/technicalwriting101 • u/developeradvacado • Jan 02 '24
RESOURCE Recommendation: How to source hard-to-find technical writing opportunities when they're only posted on company careers pages, not job boards.
**NOTE: I'm not making any profit from this, this isn't intended as a youtube plug. This resource is made with the hopes of helping even 1 person find their first role, or maybe pivot to a new one in 2024.**
This is applicable to technical writers interested in making datasheets, product guides, installation instructions, and quick start guides.
For reasons unknown to me, some businesses will only post some of these roles on their careers pages and not on job boards. Maybe it has to do with getting better quality applications, idk.
What I do know is that you can use this technique to source those technical writing opportunities, working backwards from white-label vendors.
Use this resource to explore what's out there when the job boards are quiet, and add companies to your watchlist/bookmarks/radar for their soonest opening.
https://www.youtube.com/watch?v=RtskESQ5NYM
Wishing you all the best of success in 2024. For those newly graduated or looking to get into the industry, hoping you find your first opportunity one way or the other. GL.
r/technicalwriting101 • u/timothymcmackin • Jul 12 '23
INSTRUCTION My advice on finding docs to write and researching portfolio pieces
Hi folks! We get a lot of questions about finding projects to write on and writing portfolio samples when you're getting started, so I wrote up some of my thoughts here:
Finding docs to write for your portfolio
https://timothymcmack.in/blog/finding-topics/
Researching a getting started guide
https://timothymcmack.in/blog/researching-getting-started/
These are dark-launched on my site, so you need the specific URLs. I'm working on a blog but I want to hold off on launching it until the posts are polished and engaging and until I've got several good posts to show off.
Let me know if these are helpful and if you have ideas for similar things I could walk you through.
r/technicalwriting101 • u/International-Ad1486 • Apr 17 '23
Does Your Résumé Pass the Six-Second Test?
Does Your Résumé Pass the Six-Second Test? (WSJ.com)
“Recruiters don’t have time for that,” Ms. O’Donnell said. Instead, open with a one-line “headline” stating your occupational specialty—ideally with words matching the role you’re applying for, like “digital marketing specialist” or “technical writer,” she said.
!!!!
I've been saying this for a while and was beginning to doubt myself.
I've always thought recruiters HATE the paragraph up top.
Bobby
r/technicalwriting101 • u/International-Ad1486 • Mar 30 '23
RESOURCE PORTFOLIOS! Post 'em. Feedback 'em. But be nice!
BACKGROUND: Amruta has a good background video on Portfolios
TIP: Skip to 10:05 to hear about a beginner's portfolio.
If you want to show you've got some tech skills, it's nice to strut your stuff with an open-source static website like Jekyll (Tom Johnson's site is on Jekyll). Amruta uses git and sends direct links to documents in her application.
As a hiring manager, I prefer to see your name in a dedicated domain. Can't reserve your name?
Then johnsmith44.com or johnsmith-techwriter.com
(It tells me you've invested in something and see yourself as a tech writer, even if you're a beginner.)
If you want fast and inexpensive, do this:
Create a Portfolio in <2 Hours
It's important to have a portfolio. It's also important to keep it as simple as possible. As few clicks as possible. No additional information. No personal information (viewers may be turned off by what we assume is a turn-on).
There are a lot of free and inexpensive options out there. Here's one that I've used. You can complete this basic portfolio in less than 2 hours by:
Purchasing your name URL at a place like https://pairdomains.com ($10 for your first year);
Choosing the "Weebly" free site;
Choosing a "Portfolio" template. You might want to delete all pages except the home page;
Using Canva.com to create image placeholders and insert them into your site;
Linking your sample documents to these images; and
Adding the contact form below the images.
Let's show those portfolios!
Bobby
r/technicalwriting101 • u/tw15tw15 • Sep 26 '25
List of technical writing training courses
Cherryleaf - Technical Author/Technical Writer/technical writing training course
Google - Technical writing One for developers
TCTrainNet tekom - International tekom certification
There may be others
There are also undergraduate and post-graduate courses at universities such as University of North Texas, University of Washington, University of Limerick, Cork Institute of Technology.
r/technicalwriting101 • u/kaybeeWriter • Oct 11 '24
I write instructions for loading machine centers and for assembly (manufacturing stuff); is that technical writing?
I work at a machine shop. Loading machine centers--big machines that run programs for milling/drilling/tapping/boring/etc.--is mostly about how to lift the workpiece and how to orient it onto the fixture that holds it while it's being machined, and then the correct order and amount of torque for clamping it down (it needs to be tight enough so it doesn't vibrate and cause "chatter" or other problems, but not so tight that it deforms the workpiece). Assembly is about, once the workpiece has been machined, what to stick into it, where, how, and in what order.
I have some experience with the work I've described, but I am not an expert; I follow SMEs who take me through it, and then I document it. I use a camera, Word, Creo (CAD software for models of the fixture and workpiece), and GIMP (free Photoshop-like software for editing shots of those models). I design the documents I write, and make sure they're compliant with ISO standards and our own standards for document control.
Am I doing technical writing? Is there a market for this kind of work or is it to niche? Anyone with manufacturing experience got any texts or other resources I might want to check out to get better?