r/technicalwriting • • Jan 20 '25

I scammed the scammer

Post image
1 Upvotes

r/technicalwriting • • Aug 22 '26

Markdown vs. XML explained

1 Upvotes

I occasionally run into young technical writers who have experience working in a web development or software organization but have no previous experience with XML and fail to grasp why most Fortune 500 companies use XML over Markdown.

To help better understand why XML is so popular, we need to compare the benefits of each format.

Markdown

  1. Inexpensive - ideal for web/SW startups

  2. Simple code

  3. Friendly with popular editors (e.g., Google Docs)

  4. Ideal for simple doc formats (e.g., readme.md)

  5. Best-in-class for rapid directory updates

XML (DITA)

  1. Robust, full-featured formatting

  2. Simple code, but more options

  3. Easy-to-use WYSIWYG editors

  4. Ideal for simple and complex formats

  5. Best-in-class security

  6. Ideal for eng reviews and rev control

  7. Ideal for high-volume single-sourcing

  8. Ideal for multi-channel output

  9. Content Management System support

  10. DITA file storage system best-in-class storage for docs

It has been my experience that many young technical writers do not fully understand how important the 10 XML benefits I list above are to most Fortune 500 science and technology technical writing organizations (18% s/t, 3% web/sw). Mostly, because they believe Markdown eliminates the need for many of these XML benefits. What they often overlook is that these are not optional benefits to most science and technology organizations. These are required tools of the trade and are interwoven into functional processes and systems that organizations rely on to deliver increasingly complex documentation to increasingly wider audiences, who demand an unprecedented number of custom applications to access documentation and localization through higher volumes of single-sourcing.

Markdown was never designed to manage this. It can't and, by design, won't. The sad part is that young technical writers, new to XML, experience poor XML implementations early in their careers and believe Markdown is the solution. I promise you, it is not.


r/technicalwriting • • Aug 10 '24

QUESTION How can I break into technical writing

0 Upvotes

I am looking into buying a course to enter into this industry. Is that a good idea? If not, how do you suggest I break into technical writing?


r/technicalwriting • • Mar 31 '21

How Can I Use Tech Writing to Advance the Progressive & Socialist Agenda?

9 Upvotes

I actually enjoy tech writing, but writing about robots is turning me into a soulless entity. I'd like to apply these decades of acquired skills to a field I find spiritually beneficial, but despite my attempts, I'm drawing a blank when it comes to finding the path.

I'd like to do something that somehow advances human rights, environmental rights - anything that leans toward improving the planet and the people on it.

You never know what you get back when you toss something out there. Whether you have direct links or casual suggestions, please do not hesitate to share because you never know which kernel will reveal the path I'm looking for. Thanks in advance.


r/technicalwriting • • Apr 08 '24

Tips for finding remote positions with flexible hours?

0 Upvotes

I am going on 5 years at a tech company where I write end user help docs and work full time from home. I am also a newly first time mom and I am thinking about finding something new for work. I am honestly burnt out and bored with the content that I write and am looking to spend more time with my baby and future children. My ideal situation would be fully remote, autonomous, and flexible hours/ability to make my own hours. I've thought about finding freelance positions, but what else is out there with this criteria? What types of technical writing jobs should I be searching for? Anecdotal WFH/mom experience is welcome!


r/technicalwriting • • Mar 06 '26

SEEKING SUPPORT OR ADVICE AI in Technical Writing?

0 Upvotes

Hello. How does using AI in technical writing (any other types of writing) make you feel?

I'm not a native English speaker, but I come from a country where most people are quite good at speaking English. Having said that, there are so many times when I don't know how to describe a specific system feature/functionality because I've already used up all the words in my head. When this happens, I turn to AI to give me something, anything. Then, I edit it a bit and use it in my docs.

Has this ever happened to you when you were starting out? I’m not new to technical writing. I have about 6 years of experience in this field. This makes me even more frustrated because I'm starting to think that technical writing may not be the right career for me.

Do you have any advice?


r/technicalwriting • • Jul 30 '25

Microsoft Reveals 40 Jobs at Risk due to AI

3 Upvotes

I am wondering how everyone else is feeling about this?

https://www.windowscentral.com/artificial-intelligence/microsoft-reveals-40-jobs-about-to-be-destroyed-by-and-safe-from-ai

I have seen, myself included with those postings, all the posts out there on the job market for technical writing, analysts, etc. It hasn't been great lately. There are few jobs, all senior level, no interviews. It's been hard trying to get a new job that pays decently. I have been out of school for almost 9 years, been doing technical writing all those years and I enjoy the work. I have learned tons of soft and hard skills. However when you have 10 job postings against 10,000 applicants. It's becoming a worry. I have looked into PM, Analyst positions, etc. and even those are starting to look dismal in the light of AI. Do I go back to school? Do I jump ship and start from scratch in a different type of position?

So how is everyone else coping? How can we battle or go hand-in-hand with AI?


r/technicalwriting • • Oct 25 '21

JOB [Hiring] Tech-savvy content writer for How-to Guides & Rankings

1 Upvotes

Hello guys,

We've launched several new projects that need content, and we are once again looking for a skilled, self-motivated tech writer who is experienced in creating user guides/how-to articles/rankings on tech-related topics for Windows & macOS!

Key points:

  • Payment: Our standard rate starts at ~ $0.10 per word for an article.

  • Experience: We’re open to both experienced authors with a solid portfolio and promising beginners!

  • Commitment: We are open to both full-time and part-time employees.

You qualify for this position if you are:

  • An experienced Windows/macOS user.

  • Fluent in English.

  • Tech-savvy.

Already interested? Email me at [email protected]. The details are below.

It would be an advantage if you are also:

  • Familiar with WordPress. We are ready to pay extra if you are ready to self-publish your own articles and format them according to our guides & requirements.

  • Able to create unique screenshots. We love when our writers create unique screenshots to support their content.

  • Have basic HTML/CSS skills: Making WordPress articles beautiful often requires basic HTML/CSS skills.

  • Proficient in SEO basics. Your articles should not only be well-written but also meet basic SEO requirements, which we’ll explain to you.

  • Familiar with writing guides. Practical experience in writing in-depth technical blogs and guides would be a huge advantage.

  • Active on social media. Our authors publish their articles on our sites using their real names and provide links to their professional social networks (Twitter, LinkedIn, etc.). This will be a huge plus for your portfolio.

  • Have authority on the topic. Writers who already have publications on similar topics on other established websites are very welcome.

Things we won't tolerate:

  • Bad English.

  • Imposters.

  • Plagiarism.

What kind of articles you will be writing:

  1. Classic how-to guides on data recovery (example #1 & example #2);

  2. How-to articles which are partially related to data recovery (example);

  3. Reviews of data recovery software products for Windows/macOS (example #1 & example #2);

  4. Ranking-based articles (example #1 & example #2);

  5. Articles on technical topics related to Windows/macOS (example #1 & example #2);

  6. News & general articles (example).

How to get started:

  1. Briefly describe what makes you a good fit and send a few examples of your past work (at [email protected]).

  2. Wait for us to get in touch with you.

  3. Familiarize yourself with our product.

  4. Write one paid trial article to demonstrate your writing skills.

  5. Wait for our feedback and, hopefully, join our team.

We look forward to hearing from you!


r/technicalwriting • • Jan 23 '23

Leveraging ChatGPT as a technical writer

0 Upvotes

Hello fellow technical writers! I've been exploring ways to leverage ChatGPT to improve my work efficiency. ChatGPT's capabilities have been a game-changer for me, from content creation to editing. I would love to hear how others are utilizing this technology to streamline their workflow. Let's share tips and tricks for making the most of ChatGPT in technical writing!


r/technicalwriting • • May 17 '25

Technical Writing Career- Help!!

0 Upvotes

Can someone please give me advice on how to get into technical writing with a journalism/mass comm degree. Thank you so much! I just graduated and am trying to find a job. Very difficult.


r/technicalwriting • • May 14 '23

SEEKING SUPPORT OR ADVICE Looking to switch into an instructional design role from technical writing in India. Need advise.

0 Upvotes

Hi. I am currently working in a fintech company for the past 6 months as a technical writer. I have done numerous internships in the technical writing field and passed my masters in engineering on computer science. However, while joining the role as a technical writer, I had high hopes that I will be assigned to write documents as soon as my training is over. However, that has not been the case. Most of the days, I am assigned to go through heaps and heaps of documentation and my senior quizzes them on the information learnt. Then he copies some content from existing documentation, spices it up a little and even if I have my inputs, it's ignored and his content goes in. I am throughly discouraged by this. As I set out to search for a new role, I came across a instructional design job post.

My question is that is it a good thing for me to change into this role, considering I want to make a solid career in writing related to technology? I also hope to be a corporate trainer someday as I am into teaching and technology. Will this move support it?

Please help me out with your opinions. Thank you.


r/technicalwriting • • Apr 11 '25

Breaking Into Technical Writing

0 Upvotes

Hello, knowledgeable folks!

I currently work as a veterinary technician. For various reasons, I am interested in leaving the field and transitioning to technical writing. Specifically, my knowledge of medicine and medical terminology are solid, so I was considering starting in medical writing.

Here are the problems:

  • I have bachelor's and master's degrees in a completely unrelated field (classical music) and no formal degree or certificate in writing

  • Although I have written many things for many of my jobs, including advertising copywriting, medical notes, and templates for surgical procedures and after care instructions, I have no portfolio

  • I obviously have no experience in the technical writing field

I am also aware that the job market may not be what it used to be, and that AI is changing the way writers do their jobs.

My question: Is this folly? Do I even stand a chance?

My secondary question: If this is something even remotely achievable, what are my best next steps?

Caveats:

  • I am willing to put in time and funds, but both are low so I'd like the best bang for my buck.

  • I'm a single, unsupported mother and I need to sustain my current FT job for financial and insurance purposes until transitioning to a different FT position with benefits. Because of this, freelancing or contract work is not something I'm considering right now.

Writing with clarity and purpose has always given me great joy, and I am excited to start this adventure. That being said, I can take criticism and harsh truths. Lay it on me.


r/technicalwriting • • Nov 23 '25

AI - Artificial Intelligence best AI for creating work procedure documents

0 Upvotes

i am looking for an AI to save up time on writing work procedures. Typically it takes me between 150-300 hours to write 1 document due to the fact I need to refer to at least 10 different documents to write 1 procedure. 2 month ago I tried my luck with GPT5 and I realized I didnt save much time. I had to repeat instructions multiple times and it was frustrating. GPT5 couldnt extract the images & tables from the docs. Worse, it missed critical info on multiple occasions and added false information and values. GPT5 gave me a 40% ready document. I spent around 100hours correcting the documents. anything better that is available today? I don't mind paying if I can get a document that's atleast 70% done.


r/technicalwriting • • Feb 27 '26

Pedantic word choices

0 Upvotes

I'm in the middle of procedure documentation review for my site. One of the procedures has the phrase "once a week" for the frequency of an activity. The "a" has always bugged me because I think it should be "per". About 95% of me thinks I feel this way because "a" in this phrase feels informal. I've done a bit of searching but I'm coming up short on anything with an answer. Anyone have any suggestions where to look?

The other 5% of me thinks its another till/until situation and im just going to have to live with it


r/technicalwriting • • Jan 21 '23

I wanna be a technical writer where can I learn about it? Any online free course available?

1 Upvotes

r/technicalwriting • • Jun 08 '24

Advice for entering technical writing for someone with a strong background in writing

0 Upvotes

Hi everyone.

I have an extensive background in writing. I majored in philosophy at an Ivy League school and went on to get a master's in philosophy from a top-ranked program. While in graduate school, I worked at a graduate student only writing center for 5 years, often consulting with students working on complex dissertations in a variety of fields (including more technical fields like CS). I have polished writing from my graduate level studies as well as two articles I published as an undergraduate in prestigious undergraduate journals. Though they are in philosophy, they are quite technical; much of my philosophical work involved higher level math (computability and recursion, set theory) and logic (second-order logic, metalogic, non-standard logics).

I currently work at a writing center at a local community college and the pay is absolute crap (~$20/hr). I'm writing here to ask the community what the next best steps are for someone with my background to get into technical writing. I've never done technical writing per se, but believe I'd enjoy it, and would hope to increase my income significantly.

My naive thoughts on trying to enter the field:
-Start by getting some sort of certificate or by taking an online course to get familiar with the actual ins and outs of technical writing (which from what I understand requires being more than just a great writer--familiarity with certain best practices and software, for example)
-Apply for technical writing jobs through LinkedIn. I've applied to many but have never gotten an offer. Given my strong background in writing, I'm not sure what I'm missing. One issues might be that I'm now 38 and my graduate student years and the majority of my writing center consulting was 10+ years ago (though I have freelanced somewhat since then).
-Try to get a technical writing job through some other means--but what that might be I don't know.

Any feedback or advice would be greatly appreciated. I'm 38 with two fancy degrees and find it frustrating that I haven't been able to find something that compensates me appropriately (when my current job hired me, the director even said "we can't pay you NEARLY what you're worth). I'd like to know who WILL pay me for what I'm worth.

Thanks again.


r/technicalwriting • • Jul 15 '21

Got tech publishing or tech blogging questions?

1 Upvotes

Hi Tech Writing Gurus,

I am an accomplished tech author with years of experience, going all the way back to 2009, writing multiple tech books (self published on KDP/CreateSpace as well as with big publishing shops such as Pearson Education). I have also participated in number of private/confidential KDP programs with Amazon. I have also worked in the big tech and have interacted with dozens of tech writers.

I am sure you can learn from my successes and failures along the way, so I'd be happy to take any questions from anyone.

PS: Here are my author profiles:

https://kdplaunchteam.com/our-story/

https://amzn.to/3r7acJi


r/technicalwriting • • Jan 05 '26

AI - Artificial Intelligence I think the technical writing profession is evolving into the "enterprise ontology reliability" profession

0 Upvotes

I think that in the near future, most of the value of enterprises will be in the intellectual property of how they connect their representation of the real world and package that knowledge effectively for internal and external agents (and the users behind agents). And I think technical writers are very well poised to own this niche - we can capture that knowledge, manage its permissions, and keep it up to date across entire enterprises. What do you think?

Related article: https://venturebeat.com/technology/intelition-changes-everything-ai-is-no-longer-a-tool-you-invoke

Here's the text of the article I read today:

"AI is evolving faster than our vocabulary for describing it. We may need a few new words. We have “cognition” for how a single mind thinks, but we don't have a word for what happens when human and machine intelligence work together to perceive, decide, create and act. Let’s call that process intelition.

Intelition isn’t a feature; it’s the organizing principle for the next wave of software where humans and AI operate inside the same shared model of the enterprise. Today’s systems treat AI models as things you invoke from the outside. You act as a “user,” prompting for responses or wiring a “human in the loop” step into agentic workflows. But that's evolving into continuous co-production: People and agents are shaping decisions, logic and actions together, in real time.

A unified ontology is just the beginning In a recent shareholder letter, Palantir CEO Alex Karp wrote that “all the value in the market is going to go to chips and what we call ontology,” and argued that this shift is “only the beginning of something much larger and more significant.” By ontology, Karp means a shared model of objects (customers, policies, assets, events) and their relationships. This also includes what Palantir calls an ontology’s “kinetic layer” that defines the actions and security permissions connecting objects.

In the SaaS era, every enterprise application creates its own object and process models. Combined with a host of legacy systems and often chaotic models, enterprises face the challenge of stitching all this together. It’s a big and difficult job, with redundancies, incomplete structures and missing data. The reality: No matter how many data warehouse or data lake projects commissioned, few enterprises come close to creating a consolidated enterprise ontology.

A unified ontology is essential for today’s agentic AI tools. As organizations link and federate ontologies, a new software paradigm emerges: Agentic AI can reason and act across suppliers, regulators, customers and operations, not just within a single app.

As Karp describes it, the aim is “to tether the power of artificial intelligence to objects and relationships in the real world.”

World models and continuous learning Today’s models can hold extensive context, but holding information isn’t the same as learning from it. Continual learning requires the accumulation of understanding, rather than resets with each retraining.

To his aim, Google recently announced “Nested Learning” as a potential solution, grounded direclty into existing LLM architecture and training data. The authors don’t claim to have solved the challenges of building world models. But, Nested Learning could supply the raw ingredients for them: Durable memory with continual learning layered into the system. The endpoint would make retraining obsolete.

In June 2022, Meta's chief AI scientist Yann LeCun created a blueprint for “autonomous machine intelligence” that featured a hierarchical approach to using joint embeddings to make predictions using world models. He called the technique H-JEPA, and later put bluntly: “LLMs are good at manipulating language, but not at thinking.”

Over the past three years, LeCun and his colleagues at Meta have moved H-JEPA theory into practice with open source models V-JEPA and I-JEPA, which learn image and video representations of the world.

The personal intelition interface The third force in this agentic, ontology-driven world is the personal interface. This puts people at the center rather than as “users” on the periphery. This is not another app; it is the primary way a person participates in the next era of work and life. Rather than treating AI as something we visit through a chat window or API cal, the personal intelition interface will be always-on, aware of our context, preferences and goals and capable of acting on our behalf across the entire federated economy.

Let’s analyze how this is already coming together.

In May, Jony Ive sold his AI device company io to OpenAI to accelerate a new AI device category. He noted at the time: “If you make something new, if you innovate, there will be consequences unforeseen, and some will be wonderful, and some will be harmful. While some of the less positive consequences were unintentional, I still feel responsibility. And the manifestation of that is a determination to try and be useful.” That is, getting the personal intelligence device right means more than an attractive venture opportunity.

Apple is looking beyond LLMs for on-device solutions that require less processing power and result in less latency when creating AI apps to understand “user intent.” Last year, they created UI-JEPA, an innovation that moves to “on-device analysis” of what the user wants. This strikes directly at the business model of today’s digital economy, where centralized profiling of “users” transforms intent and behavior data into vast revenue streams.

Tim Berners-Lee, the inventor of the World Wide Web, recently noted: “The user has been reduced to a consumable product for the advertiser ... there's still time to build machines that work for humans, and not the other way around." Moving user intent to the device will drive interest in a secure personal data management standard, Solid, that Berners-Lee and his colleagues have been developing since 2022. The standard is ideally suited to pair with new personal AI devices. For instance, Inrupt, Inc., a company founded by Berners-Lee, recently combined Solid with Anthropic’s MCP standard for Agentic Wallets. Personal control is more than a feature of this paradigm; it is the architectural safeguard as systems gain the ability to learn and act continuously.

Ultimately, these three forces are moving and converging faster than most realize. Enterprise ontologies provide the nouns and verbs, world-model research supplies durable memory and learning and the personal interface becomes the permissioned point of control. The next software era isn't coming. It's already here.

Brian Mulconrey is SVP at Sureify Labs."


r/technicalwriting • • Feb 10 '26

SEEKING SUPPORT OR ADVICE Which AI detection tool to use?

0 Upvotes

I'm writing a document with the help of AI but I don't want the end product to sound like AI. which tool should I use to run on my document and check AI %?


r/technicalwriting • • May 12 '26

How to Make Your Documentation AI-Ready: A Practical Step-by-Step Guide

0 Upvotes

r/technicalwriting • • Aug 02 '24

SEEKING SUPPORT OR ADVICE Question about getting first job

0 Upvotes

Hi all,

I’ve gone through the career faq thing and didn’t find an answer so posting here. I recently graduated with a Master of Fine Arts in Creative Writing. My undergrad was a double major in English and Spanish. All of my professional experience has been either in school districts or in academia in some capacity, and I have minimal technical knowledge. I do have a few minor publications, but they’re pretty minor. That said, there’s also nothing I’m not willing to put the work into learning. I guess I’m wondering if it’s realistic to think I might be able to land some sort of tech writing job or if I should just dedicate my time to other paths forward. I feel like my and my friends’ (including friends in STEM) experiences lately is that everything is just a lot more competitive, and given my lack of tech and technical writing jobs I’m not sure if it’s worth trying to apply. Thanks so much!


r/technicalwriting • • Jul 18 '26

RESOURCE Getting in to technical writing.

0 Upvotes

I am an Engineer and suck at technical writing. I either write with such detail that even I hate reading it over and get confused, or I write at such a low level that it feels like a 2nd grader's report.

I do a lot of technical writing, responding to customers' technical questions or questions about specifications, but I have no clue what I am doing. I do not know how to write technically or persuasively. All of my writing classes in college were glanced over, and even the professors admitted that AI will take everything over.

How can I dive into this and learn how to write better? Is it just something you power through and get reps?


r/technicalwriting • • Mar 07 '25

QUESTION I need help

0 Upvotes

I'm a new employee and they told me to write a documentation about the systems in the company. there are 11 systems, they give me the user manual and I can contact with some of the developer, but I don't know how to write it. Please help me how to start. How can I document everything about the system? Please please please? I need help.


r/technicalwriting • • Sep 27 '24

QUESTION Explain to me like I’m 5, please.

0 Upvotes

Hi everyone. I am a 32M and work as a copywriter in a creative driven ad agency. It’s fun, challenging, fulfilling and whatever adjective you can think of. I am curious about this technical writing. I get it’s like instruction manuals and things lien that. And another thing I am frustrated about advertising is the uncertainty of the industry. Job security is hard to come by and I don’t like that. How is technical writing industry on that front? And how should I start learning the craft? I’d love all suggestions or just tell me I’m an idiot. Either way- thanks for your time!!