Technical Writing Blog

Something shifted in how technical writers think about video, and it's mostly because the editing part got a lot less painful. AI tools like Descript, Synthesia, HeyGen, and Guidde are making it possible to go from a rough screen recording to a polished, captioned, multilingual video, without a production team or a full day of editing. That changes what's realistic for documentation teams. Voiceovers, captions, avatar-based walkthroughs, workflow capture: things that used to require specialists now fit into a solo writer's process. And once the video exists, embedding it into ClickHelp is straightforward – via URL or an HTML block. This article breaks down the tools, the workflow, and what actually matters when adding video to a documentation project. Read the full article 🎬

AI agents are no longer just “search tools for documentation.” Something more interesting is happening: they’re starting to actually interact with documentation systems, not just pull answers out of them. MCP (Model Context Protocol) is what makes this possible. It gives AI agents a structured way to connect to a documentation portal — so they can use context, access information more intelligently, and work with the content instead of just reading it. That shifts the whole idea of documentation. It’s no longer just a place where information lives. It becomes something closer to an environment where AI can operate. And by the way, ClickHelp already supports MCP, which makes this kind of integration much easier to implement in real documentation workflows. We’re getting closer to documentation that behaves less like “pages” and more like a system that can be worked with. Worth a read if you’re into AI, developer experience, or technical writing. Read the full article

Agent Assist software is quietly transforming modern customer service, not by replacing human agents, but by empowering them. Here’s what AI can do in support workflows: • suggest responses in real time • instantly surface relevant knowledge base articles • reduce time spent searching for information • lower cognitive load for agents • improve consistency across responses 📉 The result: faster resolution times, smoother workflows, and better customer experience. Read the full article

A user opens your product for the first time. Gets confused. Opens Google. Closes your app. Sound familiar? In-app help is what prevents that. It’s guidance built directly into the software (tooltips, step-by-step walkthroughs, onboarding tours, embedded knowledge bases) available exactly when and where users need it. In this article: • What in-app help actually includes • Which formats work for which situations • Key features to look for in tools • Side-by-side comparison of Pendo, Whatfix, WalkMe, UserGuiding and more 📖 Read here

Most documentation portals are invisible to AI tools. Not because the content is bad. Because the platform serves HTML that AI assistants can't reliably parse: navigation, scripts, sidebars, all wrapped around the few paragraphs that actually answer the question. As a result, users ask ChatGPT about your product and get a confident but incorrect answer. Or no answer at all. There are three things that actually fix this at the platform level: - clean content delivery, - Markdown access, - and a machine-readable index. None of them require changing how you write documentation. We wrote about what's breaking and what changes when you fix it at the source. 👉 Read here

When teams talk about software architecture, they often think about diagrams, frameworks, and system design. But there’s one critical piece that often gets overlooked: documentation. Without clear architecture docs, important knowledge stays in conversations, chats, or in the heads of a few engineers. Over time, this creates confusion, slows onboarding, and makes system changes much riskier than they should be. Good architecture documentation helps answer essential questions: • How is the system structured? • Why were certain design decisions made? • How do components interact? • What should new team members understand first? A well-documented architecture becomes a shared map for the whole team — developers, architects, managers, and stakeholders. It improves communication, reduces misunderstandings, and makes scaling much easier. This article explains what effective architecture documentation should include and how to make it actually useful in real projects. Read the full guide here ✍🏼

Developer documentation is more than just a README. Today, it’s core infrastructure for IT teams: — it speeds up onboarding — reduces incidents — simplifies system maintenance In this article, we break down: • why dev docs really matter • how to write documentation for different roles • which tools to use • how to keep docs up to date Plus: practical examples like quickstarts, runbooks, and API docs. Read here

ClickHelp April 2026 update is live. The main thing: MCP Server. Claude and Cursor can now connect to your ClickHelp portal directly — read docs, create topics, update TOCs. What else shipped: - API v2: cleaner REST, Markdown output, OpenAPI specs, - AnswerGenius external widget — choose your own sources - Language switcher in Next Reader UI - Copy any topic as Markdown in one click Read the details

Want to create online software tutorials that actually help users (not confuse them)? In our guide, we break down: • What makes a tutorial effective • Different formats (video, text, interactive) • Step-by-step creation tips • How tools like ClickHelp simplify the process If you're working with SaaS, documentation, or product education 👉 this is for you

🗺 Which mind mapping tool should you use in 2026? We compared five of the most popular options: from lightweight Coggle to enterprise-grade MindManager, across the features that actually matter: real-time collaboration, AI, offline support, integrations, and free plans. Here's the short version: • Miro — best for team brainstorming and visual planning on a shared canvas • XMind — clean maps, strong offline mode, great export options (PDF, PPT, Word) • MindManager — enterprise project planning with Gantt charts and Excel integration • Coggle — simple, free to start, no setup required • MindMeister — turns ideas into tasks directly via MeisterTask integration 👉 Full article

AI is reshaping how we build products — and Product Requirements Documents (PRDs) are no exception. But here’s the question: 👉 Do we still need PRDs in the age of AI? In our latest article, we explore: • How AI changes the way PRDs are written • What stays essential (hint: clarity still wins) • Practical tips for making PRDs more effective with AI tools If you're working with product docs, this is worth a read. 🔗 Read the full article

🔍 Enterprise search is evolving fast Modern systems go far beyond keyword matching — they use AI, NLP, and semantic understanding to deliver precise answers across large volumes of data. In this guide, you’ll learn: • key types of enterprise search • how it works • AI-powered capabilities • implementation checklist 👉 Read the full guide

New ClickHelp release dropped 🤓 The big idea: your docs should be readable by AI, not just people. We rebuilt the Reader UI from scratch, added native Markdown access, llms.txt support, and an MCP Server so AI agents can work with your portal directly. Full breakdown → ✍🏼

📄 DocOps — more than just Docs-as-Code DocOps is about building documentation that actually scales. It’s not just storing files in Git — it’s automating workflows, enabling team collaboration, and choosing tools that fit your process. Teams can mix and match: - Markdown editors like Obsidian or VS Code for drafting - Collaborative tools like Google Docs for initial review - Help authoring platforms like ClickHelp for structured content, single-sourcing, and conditional publishing ✅ Writers stay productive without deep coding knowledge ✅ Content reuse and versioning are easier ✅ CI/CD integration is possible when needed Learn how to set up your DocOps stack

Many teams still treat documentation as a “nice-to-have.” In reality, it directly impacts how fast a product evolves and how easy it is to work with. Here’s the key idea 👇 Code-to-docs is an approach where documentation is partially generated automatically from code using tools and AI. What you get: — faster documentation creation and updates — less manual work — easier to keep docs in sync with code But there’s a catch ⚠️ Automation is great at explaining what the code does, but not why it was designed that way. 📌 Key takeaway: Documentation is not a final step — it’s part of development. If you write it “later,” it will almost always become outdated. Good documentation: ✔️ speeds up development ✔️ improves onboarding ✔️ reduces errors ✔️ removes dependency on “the one person who knows everything” In the end, it directly affects how well your team and product scale. Read full article

A developer portal is more than a dashboard. It’s a central platform where engineering teams can discover services, provision infrastructure, access APIs, deploy applications, and follow standardized workflows — all in one place. Backstage, OpsLevel, Kubernetes, and integrated documentation tools like ClickHelp bring everything together. Developers can focus on building software instead of hunting for tools or documentation. As the platform grows, it scales across teams and services. More workflows, automated scorecards, AI-assisted insights, and documentation integration appear. The portal becomes a central hub, coordinating people, processes, and infrastructure. The takeaway: a developer portal isn’t just a tool — it’s the backbone of modern platform engineering, improving productivity, enforcing best practices, and unifying complex software ecosystems. Full article ↓

Docs as Code works great — until documentation starts scaling. A team builds docs around Git, Markdown, and CI/CD. Developers contribute easily, everything is versioned, updates move fast. Then the documentation grows. More writers join. SMEs need to review content. Localization teams get involved. The portal expands to hundreds or thousands of topics. And the workflow designed for developers starts creating friction for everyone else. The problem isn’t Docs as Code itself — it works extremely well for developer-driven documentation. But when documentation becomes a large collaboration environment, teams often start exploring hybrid documentation platforms that combine structured workflows with visual editing and built-in publishing. The takeaway: Docs as Code is powerful, but it doesn’t fit every documentation scenario. Full article here

A company set out to build an AI bot that could answer employee questions. At first, it seemed like the model was the problem: weak answers, confusion, “I couldn’t find information.” They tried everything — better LLMs, larger context, hybrid search. But the real issue was simpler: The knowledge didn’t exist. The bot wasn’t failing. It was honestly exposing where the documentation was thin, missing, or unclear. Once the team started analyzing unanswered questions and writing targeted articles, answer quality improved fast. The takeaway: AI doesn’t replace knowledge. It amplifies what you already have — and reveals what you don’t. Full story ↓

Most doc teams share the same problem: - Different people write docs → inconsistent quality - No data on where users actually struggle - AI bots close tickets but never fix root causes - No system for prioritizing what to write next Sound familiar? On February 26, we're showing a different way. ClickHelp AI Suite turns user questions into actionable insights — so you know exactly what to improve and why. → Live demos: AnswerGenius in portal, embedded in product, federated search → Analytics in action: real examples from ERP & SaaS → Clear framework: docs fix vs. product escalation For Technical Writers, PMs, Support Teams & Developers. 🗓 Feb 26 · 10:00 EST / 16:00 CET 🎁 Live attendees get beta access + free email course 👉 [Register here]

Docs as Code: Documentation Managed Like Code Maintaining a large user guide can be challenging. Some teams still use Word or Google Docs, which often leads to version confusion and lost updates. Others rely on modern documentation platforms, combining version control, structured publishing, and a user-friendly editor. And then there are teams that adopt Docs as Code, managing documentation like source code with Git and CI/CD. In our article, we explore: - What Docs as Code is and how it works - Key benefits for teams - Real-world examples - Practical considerations 📌 Read the full article and find out if this approach fits your documentation workflow