# technical-writing Published articles for technical-writing. This is one page of public article previews, not the complete archive. Follow Next page to continue. Summaries are not the original full articles. ## Content Governance: Keeping Documentation Trustworthy DevFeed: [Content Governance: Keeping Documentation Trustworthy]() Original publisher: [Read original article]() Author: Selvaraaju Murugesan Published: 2026-08-14T13:14:46Z Content type: article Language: en Sources: [Knowledge Management Tips, Best Practices and More]() Topics: [Documentation](), [Security](), [audit](), [trust](), [AI Agent](), [Requirements]() Tags: [agent](), [ai](), [audit](), [auditability](), [content](), [documentation](), [governance](), [security](), [technical-writing](), [trust]() ### AI overview This article explains content governance as a structured practice for keeping documentation accurate, secure, compliant, and trustworthy for both human readers and AI agents. It highlights regular audits, quality control, access controls, privacy and compliance checks, and synchronization with software releases. ### Source excerpt Only 21% of business and IT leaders report having a mature governance model ... The post Content Governance: Keeping Documentation Trustworthy appeared first on Document360. ## JulyReply - Re: Stuck in draft DevFeed: [JulyReply - Re: Stuck in draft]() Original publisher: [Read original article]() Author: Harsh Shandilya Published: 2026-07-09T18:52:00Z Content type: opinion Language: en Sources: [Posts on Harsh Shandilya]() Topics: [Learning](), [Parser](), [REST API](), [Containers](), [Git](), [Cloudflare](), [Compose](), [LLMs](), [Command-line interface]() Tags: [blog](), [blog-posts](), [blogging](), [cli](), [cloudflare](), [compose](), [containers](), [git](), [julyreply](), [llms](), [rest-api](), [technical-writing]() ### AI overview The author reflects on managing unfinished blog drafts, explaining that feedback, public interest, curiosity, and motivation sometimes lead to completion while many drafts are abandoned. They invite readers to vote on several proposed technical topics, including Retrofit, an HTML parser, Git, Docker containers in NixOS, Cloudflare, Compose UI, and LLM-assisted development. ### Source excerpt On drafts and being okay with them ## Agent Score evaluates whether documentation is ready for AI agents DevFeed: [Agent Score evaluates whether documentation is ready for AI agents]() Original publisher: [Read original article]() Author: Ethan Palm Published: 2026-04-27T00:00:00Z Content type: article Language: en Sources: [Mintlify Blog]() Topics: [AI Agent](), [Documentation](), [Developer experience](), [AI-assisted coding](), [observability](), [Authentication]() Tags: [agent](), [ai-agent](), [announcements](), [coding-agents](), [documentation](), [observability](), [technical-writing]() ### AI overview Mintlify introduces Agent Score, a free tool that evaluates documentation against 29 checks for agent readiness. It assesses discoverability, Markdown availability, page size, content structure, URL stability, observability, and authentication using the Agent-Friendly Documentation Spec and additional checks. ### Source excerpt An AI agent is reading your documentation right now. How well is it doing? We built a free tool to check how agent-ready your content is based on the agent-friendly documentation spec. ## How Mintlify uses Claude Code as a technical writing assistant DevFeed: [How Mintlify uses Claude Code as a technical writing assistant]() Original publisher: [Read original article]() Author: Ethan Palm Published: 2025-08-19T00:00:00Z Content type: article Language: en Sources: [Mintlify Blog]() Topics: [Claude Code](), [Documentation](), [Code](), [configuration](), [context]() Tags: [ai-trends](), [claude-code](), [code](), [configuration](), [context](), [documentation](), [memory](), [quality](), [review](), [technical](), [technical-writing](), [terminal](), [tools](), [workflows]() ### AI overview Ethan Palm describes how Mintlify uses Claude Code as a technical writing assistant. The workflow includes CLAUDE.md guardrails, persistent memory across sessions, custom skill commands, and support for planning, drafting, updating, and reviewing documentation. The article emphasizes verifying all AI-generated documentation with human expertise. ### Source excerpt As the sole technical writer at Mintlify, I'm always looking for ways to improve my workflows and empower other people on my team to contribute to the docs. I also want to take a vacation without blocking docs ships for a week and a half. ## How Pinecone writes documentation DevFeed: [How Pinecone writes documentation]() Original publisher: [Read original article]() Author: Tiffany Chen Published: 2025-07-25T00:00:00Z Content type: article Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [Information Architecture](), [Claude Code](), [data-modeling]() Tags: [architecture](), [best-practices](), [claude-code](), [developer](), [documentation](), [onboarding](), [technical-writing]() ### AI overview An interview with Pinecone documentation lead Jesse Seldess about restructuring documentation around user goals, improving information architecture, using Claude Code for content reviews, and hiring technical writers who collaborate across teams. ### Source excerpt Jesse Seldess runs documentation at Pinecone, where he's shaping how developers learn and succeed with one of the leading vector database platforms. Previously, he's scaled developer education from the ground up at renowned organizations like Cockroach Labs. ## How Anaconda writes documentation DevFeed: [How Anaconda writes documentation]() Original publisher: [Read original article]() Author: Tiffany Chen Published: 2025-05-16T00:00:00Z Content type: article Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [Artificial Intelligence](), [Microsoft]() Tags: [ai](), [best-practices](), [documentation](), [strategies](), [strategy](), [structure](), [technical](), [technical-writing](), [workflow]() ### AI overview Anaconda's technical writing manager explains how he scaled documentation from a solo effort into a team workflow using prioritization, style guides, and formal new-product introduction processes. He also describes AI's role in repetitive tasks while emphasizing human oversight for quality and accuracy. ### Source excerpt We sat down with Idan Englander, Manager of Technical Writing at Anaconda, to discuss how he scaled from being a solo writer, what documentation processes actually work, and where AI fits (and doesn't) in the writing workflow. If you're curious about more of Idan's writing principles, check out our Guide to Technical Writing. ## Fireside Chats: Gong's Approach to Software Documentation DevFeed: [Fireside Chats: Gong's Approach to Software Documentation]() Original publisher: [Read original article]() Author: Tiffany Chen Published: 2025-02-18T00:00:00Z Content type: opinion Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [Software](), [legacy]() Tags: [ai-trends](), [documentation](), [incremental](), [legacy](), [quality](), [structure](), [technical-writing]() ### AI overview Jeffrey Aftel of Gong discusses rebuilding legacy software documentation through an incremental, bottoms-up process. The approach focuses on improving sections of content over time, adapting to different audience goals, treating documentation as part of the product, and hiring technical writers who understand the product and challenge assumptions. ### Source excerpt We sat down with Jeffrey Aftel, Director of Product Writing at Gong, to discuss his approach to rebuilding legacy software documentation, his principles for impactful content, and the traits he looks for in technical writers. Jeff's background also includes technical writing leadership roles at HP and Velo by Wix. ## Breaking down common documentation mistakes DevFeed: [Breaking down common documentation mistakes]() Original publisher: [Read original article]() Author: Tiffany Chen Published: 2025-01-23T00:00:00Z Content type: article Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [Tutorial](), [Framework](), [User experience (UX)]() Tags: [best-practices](), [documentation](), [how-to](), [pitfalls](), [technical](), [technical-writing](), [ux]() ### AI overview The article examines common documentation mistakes, including mixing content types, unclear audience targeting, basic quality problems, and using documentation to compensate for product or UX issues. It recommends organizing content with the Diรกtaxis framework, defining audiences, and maintaining quality standards. ### Source excerpt Good documentation just feels right, while bad docs leave you frustrated--but pinpointing what went wrong can be tough. ## Focus on decisions, not tasks DevFeed: [Focus on decisions, not tasks]() Original publisher: [Read original article]() Published: 2024-10-15T00:00:00Z Content type: opinion Language: en Sources: [technicalwriting.dev]() Topics: [decision-making](), [Documentation](), [context]() Tags: [communication](), [decision-making](), [documentation](), [strategy](), [technical-writing](), [writing]() ### AI overview The article argues that technical documentation should support users' decisions, not merely help them complete tasks. It emphasizes documenting context, required decisions, consequences, and useful resources or references. ### Source excerpt Documentation needs to help people make decisions, not just accomplish tasks. ## Doctave Studio 2.0 Beta: The editor for technical writing and docs-as-code DevFeed: [Doctave Studio 2.0 Beta: The editor for technical writing and docs-as-code]() Original publisher: [Read original article]() Author: Doctave Team Published: 2024-10-08T05:00:00Z Content type: release Language: en Sources: [Doctave - Build beautiful developer portals with docs-as-code]() Topics: [Documentation](), [Tooling](), [Markdown](), [OpenAPI Specification](), [CI/CD]() Tags: [announce](), [assets](), [auto-complete](), [beta](), [blog](), [ci-cd](), [components](), [docs](), [docs-as-code](), [editor](), [real-time](), [technical-writing]() ### AI overview Doctave announces the public beta of Doctave Studio 2.0, an editor for technical writing and docs-as-code. The beta includes a modern editor, real-time Markdown and OpenAPI previews, auto-complete for links and assets, and inline Markdown error reporting. ### Source excerpt We're excited to announce that Doctave Studio 2.0 is now available in public beta! Doctave Studio is a new editor for technical writing and docs-as-code, and we're excited to share it with you. Want to see it in action? Here's a quick introductory video of Doctave Studio 2.0: If you just want to see how to participate in the beta, you can jump straight to the end of this post Why build a new editor? One of the biggest issues with docs-as-code is inconsistent tooling. While there are great tools out there (like Vale), it's really hard to create a great authoring environment for docs-as-code. Getting spell check, broken links checking, auto-complete, and more configured is often too complex or time consuming, that lots of authors live without these tools. This problem is compounded when you have multiple authors collaborating on the same documentation. One will have a spell checker configured, one will have auto-complete configured, another doesn't have a broken links checker. The lack of a common authoring system causes friction, confusion, and ultimately raises the barrier for contributions. And after all that, you still need to set up these same checks in your CI/CD pipeline! This is what we set out to solve with Doctave Studio 2.0. We've already made it easy to host, version, and review docs-as-code projects with our existing product. Now we're taking the next logical step and improving the docs-as-code authoring experience. What's in the Doctave Studio 2.0 beta? Today we're launching Doctave Studio 2.0 into beta with a few key features: A new, modern editor with a focus on the authoring experience Real-time previews of your content as you type (Markdown and OpenAPI!) Powerful auto-complete for your links, assets, and components Great error-reporting inline in your Markdown Let's see some of these in action! Real-time previews The right-side panel in Doctave Studio is dedicated to a real-time preview window. It shows you what your content will look like once publi ## How we are driving up the quality of internal technical documentation at Volvo Cars DevFeed: [How we are driving up the quality of internal technical documentation at Volvo Cars]() Original publisher: [Read original article]() Author: Gary Niemen Published: 2024-02-26T11:39:27Z Content type: article Language: en Sources: [Volvo Cars Engineering - Medium]() Topics: [Documentation](), [Developer experience](), [engineering-culture]() Tags: [backstage](), [blog-post](), [developer-experience](), [docs-as-code](), [documentation](), [engineering](), [platform-engineering](), [technical-documentation](), [technical-writing](), [writing]() ### AI overview The article describes how a small technical-writing team at Volvo Cars is improving the quality of internal technical documentation for more than 4,500 software engineers. It presents treating documentation like code as one part of a broader approach to scaling technical writing. ### Source excerpt How we are driving up the quality of internal technical documentation at Volvo Cars -- with just a few technical writersTreating docs like code is part of it -- but not all of itGenerated by Deep Dream Generator by Author There are many components to a great developer experience. One of them, I think we can all agree, is to have quality internal technical documentation. But how to get to that place? Few engineering organisations prioritise recruiting technical writers above software engineers. And software engineers, typically, and perfectly understandably, prefer to be coding rather than writing. The answer in the tech industry of today -- is to find a way to scale tech writing. Consider this... Many years ago, when I was working as a technical writer at one of the world's leading IT companies, the sacred ratio was one tech writer for 8-10 developers. Later, when I moved on and started working as a documentation lead in FinTech, I tried to get the company to implement this ratio -- but, alas, it was never going to fly. We settled on about 1 to 30. I was not too pleased. If only I had known what was to come. When I started working in big tech, it was more like 1 to 1000. And now at Volvo Cars, it is -- well that's what this blog post is all about. How just a few technical writers (two within a centralised developer experience function and one focusing on a specific part of the organisation) are driving up the quality of internal technical documentation among 4500+ software engineers at Volvo Cars. (What's the ratio now, huh?) As we'll describe in this blog post, moving to treating docs like code is one key component of scaling technical writing, but not the only one. Implement docs like code About five years ago when at a previous company, I stumbled across Google technical writing manager, Riona MacNamara's talk from the 2015 Write the Docs conference, Documentation, Disrupted: How Two Technical Writers Changed Google Engineering Culture. Riona was talking about solving p ## Outro: What You Did and What's Next DevFeed: [Outro: What You Did and What's Next]() Original publisher: [Read original article]() Author: Anila Zaidi Published: 2023-12-06T19:22:00Z Content type: tutorial Language: en Sources: [Squarespace](), [Squarespace Engineering Blog]() Topics: [Documentation](), [Tutorial](), [Information Architecture]() Tags: [collection](), [community](), [existing](), [information-architecture](), [technical-documentation](), [technical-writing]() ### AI overview This tutorial outro recaps the process of drafting, revising, testing, and publishing technical documentation. It then introduces next steps for organizing documentation collections with information architecture, revising existing documentation, and developing technical writing skills. ### Source excerpt The outro recaps what you did - write technical documentation! - and introduces next steps like organizing a collection of documentation, revising existing content, and expanding your technical writing skills by joining the technical writing community. ## Part 4: Test, Edit, And Publish Content DevFeed: [Part 4: Test, Edit, And Publish Content]() Original publisher: [Read original article]() Author: Anila Zaidi Published: 2023-12-05T19:46:00Z Content type: tutorial Language: en Sources: [Squarespace](), [Squarespace Engineering Blog]() Topics: [Documentation](), [Tutorial](), [Testing]() Tags: [documentation](), [technical-documentation](), [technical-writing](), [testing](), [tutorial]() ### AI overview This tutorial explains how to turn technical writing into technical documentation by testing, editing, approving, and merging the content. It presents the A-TEAM process and emphasizes testing content against the reader's goal and using a style guide during editing. ### Source excerpt After completing Parts 1, 2, and 3 of this tutorial, your once blank page now has technical writing - you're officially in the home stretch! Technical writing on a page becomes technical documentation only after you test, edit, and publish the content. Do not underestimate the exponential payoff that comes from testing and revising content. More than one technical writer can claim that revision has either uncovered bugs in software or improved it. ## Part 3: Draft Content That's Accurate, Consistent, And Concise DevFeed: [Part 3: Draft Content That's Accurate, Consistent, And Concise]() Original publisher: [Read original article]() Author: Anila Zaidi Published: 2023-11-28T17:59:00Z Content type: tutorial Language: en Sources: [Squarespace](), [Squarespace Engineering Blog]() Topics: [Documentation](), [Tutorial]() Tags: [documentation](), [glossary](), [guides](), [how-to](), [technical](), [technical-documentation](), [technical-writing](), [tutorial](), [writing]() ### AI overview Part 3 of a technical writing series explains how to draft documentation that is accurate, consistent, and concise. It recommends maintaining a glossary, defining terms and personas, using consistent terminology, and keeping content focused on readers' needs. ### Source excerpt In my opinion, creating good headings and organizing them in a way that's helpful to readers is much more challenging than drafting content. So pat yourself on the back for completing Part 2 of this series and making it to Part 3. ๐Ÿ‘ ๐Ÿ‘ ๐Ÿ‘ However, there are three things that undo exceptional headings and structure in technical documentation: content that is inaccurate, content that's inconsistent, and content that's inflated. ## Part 1: Learn The Different Types Of Technical Documentation DevFeed: [Part 1: Learn The Different Types Of Technical Documentation]() Original publisher: [Read original article]() Author: Anila Zaidi Published: 2023-11-14T19:48:00Z Content type: tutorial Language: en Sources: [Squarespace](), [Squarespace Engineering Blog]() Topics: [Documentation](), [Tutorial]() Tags: [documentation](), [technical](), [technical-writing](), [tutorial]() ### AI overview This tutorial explains the different types of technical documentation and how reader behavior, patience, experience, and goals distinguish them. It also provides examples of each content type. ### Source excerpt In the same way the term "books" includes fiction, nonfiction, and biographies as genres, the term "technical documentation" includes many different content types. But what sets technical documentation apart from books are reader traits. These traits are a result of what the reader does as they read technical documentation - they use the app. ## Technical Writing: How To Start DevFeed: [Technical Writing: How To Start]() Original publisher: [Read original article]() Author: Anila Zaidi Published: 2023-11-07T17:55:00Z Content type: tutorial Language: en Sources: [Squarespace](), [Squarespace Engineering Blog]() Topics: [Documentation](), [Tutorial](), [Learning]() Tags: [article](), [guide](), [how-to](), [technical](), [technical-writing](), [tutorial]() ### AI overview This tutorial introduces technical writing as a learnable skill and presents a structured approach to creating technical documentation. It covers documentation types, headings, drafting, revision, organization, and community participation. ### Source excerpt Writing is a learned skill. No one person is a good or bad writer. ๐Ÿ™‚ When a colleague asked me to mentor them on technical writing, I searched for a single technical writing article, guide, book, or tutorial that addressed three key things. Since I couldn't find one, I decided to create a tutorial on technical writing. ## AI Coding Tools, Technical Writing, and Blogging for Developers DevFeed: [AI Coding Tools, Technical Writing, and Blogging for Developers]() Original publisher: [Read original article]() Author: TheAnkurTyagi Published: 2023-10-18T13:36:30Z Content type: article Language: en Sources: [ByteSizedBets]() Topics: [Artificial Intelligence](), [AI tools for developers](), [ChatGPT](), [GitHub Copilot](), [coding](), [Software Engineering]() Tags: [ai](), [ai-tools](), [ai-tools-for-developers](), [chatgpt](), [code](), [github-copilot](), [technical-writing]() ### AI overview This developer newsletter discusses ChatGPT, Tabnine, and GitHub Copilot; explains technical writing for developers; and introduces blogging as a way to share knowledge and build a developer career. It also mentions CodiumAI and its use cases, but the supplied text is incomplete. ### Source excerpt AI tools, Technical Writing, Blogging Tips and Small bets Updates ## Why the Author Created Separate Notes and Articles Sections DevFeed: [Why the Author Created Separate Notes and Articles Sections]() Original publisher: [Read original article]() Author: hello@taniarascia.com Published: 2021-10-23T00:00:00Z Content type: opinion Language: en Sources: [Tania Rascia]() Topics: [Learning](), [digital](), [Redux]() Tags: [life](), [personal](), [technical-writing](), [thoughts](), [writing]() ### AI overview The author explains the decision to separate personal, casual, and random writing into a Notes section while keeping technical work in Articles. They discuss privacy, public self-expression, and preserving personal reflections alongside technical writing. ### Source excerpt Despite the fact that I've been consistently writing on here for six years now, I've said very little about myself. The writing has been... ## Experience in Google Season of Docs 2019 with Apache Airflow DevFeed: [Experience in Google Season of Docs 2019 with Apache Airflow]() Original publisher: [Read original article]() Author: Apache Airflow Published: 2019-12-20T00:00:00Z Content type: article Language: en Sources: [Apache Airflow Blog]() Topics: [airflow](), [Documentation](), [Open Source](), [Google](), [Apache Cassandra]() Tags: [airflow](), [apache-airflow](), [docs](), [documentation](), [google](), [open-source](), [technical-writing]() ### AI overview A personal account of participating in Google Season of Docs 2019 with Apache Airflow. The author describes choosing Airflow, selecting a documentation project about creating workflows, and contributing as a technical writer with support from the open-source community. ### Source excerpt I came across Google Season of Docs (GSoD) almost by accident, thanks to my extensive HackerNews and Twitter addiction. I was familiar with the Google Summer of Code but not with this program. It turns out it was the inaugural phase. I read the details, and the process felt a lot like GSoC except that this was about documentation. About Me I have been writing tech articles on medium as well as my blog for the past 1.5 years. Blogging helps me test my understanding of the concepts as untangling the toughest of ideas in simple sentences requires a considerable time investment. Also, I have been working as a Software Developer for the past three years, which involves writing documentation for my projects as well. I completed my B.Tech from IIT Roorkee. During my stay in college, I applied for GSoC once but didn't make it through in the final list of selected candidates. I saw GSoD as an excellent opportunity to improve my technical writing skills using feedback from the open-source community. I contributed some bug fixes and features to Apache Superset and Apache Druid, but this would be my first contribution as a technical writer. Searching for the organization About 40+ organizations were participating in the GSoD. However, there were two which came as the right choice for me in the first instant. The first one was Apache Airflow because I had already used Airflow extensively and also contributed some custom operators inside the forked version of my previous company. The second one was Apache Cassandra, on which I also had worked extensively but hadn't done any code or doc changes. Considering the total experience, I decided to go with the Airflow. Project selection After selecting the org, the next step was to choose the project. Again, my previous experience played a role here, and I ended up picking the How to create a workflow . The aim of the project was to write documentation which will help users in creating complex as well as custom DAGs. The final deliverabl ## Talking at the SFPUG DevFeed: [Talking at the SFPUG]() Original publisher: [Read original article]() Author: Dimitri Fontaine PostgreSQL Major Contributor; Author Published: 2013-07-19T08:24:00Z Content type: opinion Language: en Sources: [Dimitri Fontaine]() Topics: [Tool](), [Documentation](), [version](), [upgrade]() Tags: [batch](), [lag](), [technical](), [technical-writing](), [tools](), [upgrade](), [version]() ### AI overview The author recounts speaking at an SFPUG meeting in San Francisco about the latest version of Skytools. The talk highlighted missing documentation and prompted questions about upgrades, PGQ, Londiste operations, batch size, and lag. Bazaarvoice's use of Skytools contributed to its interest in the discussion. ### Source excerpt Those days feel really lucky to me. I'm currently visiting friends and customers in San Francisco, and really enjoying my trip here! Of course Josh Berkus took the opportunity to organise a SFPUG meeting and I had the pleasure of being the speaker over there. My talk was about the most recent version of Skytools and the opportunity to realise that we're still missing a lot on documentation. One of the attendee did propose to help us on that front as he apparently really likes technical writing. I hope that effort will happen and help solve the main issue here.