ch
Feedback
Technical Writing Blog

Technical Writing Blog

前往频道在 Telegram

ClickHelp — online documentation tool for technical writers and teams. Create, translate, and publish documentation easily in one portal! Get your FREE trial 👉 https://goo.gl/NahsT2

显示更多
1 266
订阅者
无数据24 小时
+27 天
-730 天
吸引订阅者
九月 '26
九月 '26
+5
在0个频道中
八月 '26
+10
在0个频道中
Get PRO
七月 '26
+5
在0个频道中
Get PRO
六月 '26
+8
在0个频道中
Get PRO
五月 '26
+6
在0个频道中
Get PRO
四月 '26
+14
在0个频道中
Get PRO
三月 '26
+11
在0个频道中
Get PRO
二月 '26
+19
在0个频道中
Get PRO
一月 '26
+22
在0个频道中
Get PRO
十二月 '25
+18
在0个频道中
Get PRO
十一月 '25
+19
在0个频道中
Get PRO
十月 '25
+17
在0个频道中
Get PRO
九月 '25
+20
在0个频道中
Get PRO
八月 '25
+26
在0个频道中
Get PRO
七月 '25
+40
在0个频道中
Get PRO
六月 '25
+17
在0个频道中
Get PRO
五月 '25
+15
在0个频道中
Get PRO
四月 '25
+16
在0个频道中
Get PRO
三月 '25
+20
在0个频道中
Get PRO
二月 '25
+22
在0个频道中
Get PRO
一月 '25
+29
在0个频道中
Get PRO
十二月 '24
+23
在0个频道中
Get PRO
十一月 '24
+30
在0个频道中
Get PRO
十月 '24
+21
在0个频道中
Get PRO
九月 '24
+28
在0个频道中
Get PRO
八月 '24
+35
在0个频道中
Get PRO
七月 '24
+30
在0个频道中
Get PRO
六月 '24
+22
在0个频道中
Get PRO
五月 '24
+32
在0个频道中
Get PRO
四月 '24
+21
在0个频道中
Get PRO
三月 '24
+35
在0个频道中
Get PRO
二月 '24
+23
在0个频道中
Get PRO
一月 '24
+40
在0个频道中
Get PRO
十二月 '23
+36
在0个频道中
Get PRO
十一月 '23
+35
在0个频道中
Get PRO
十月 '23
+51
在0个频道中
Get PRO
九月 '23
+29
在0个频道中
Get PRO
八月 '23
+43
在0个频道中
Get PRO
七月 '23
+35
在0个频道中
Get PRO
六月 '23
+31
在0个频道中
Get PRO
五月 '23
+52
在0个频道中
Get PRO
四月 '23
+28
在0个频道中
Get PRO
三月 '23
+40
在0个频道中
Get PRO
二月 '23
+39
在0个频道中
Get PRO
一月 '23
+37
在0个频道中
Get PRO
十二月 '22
+41
在0个频道中
Get PRO
十一月 '22
+45
在0个频道中
Get PRO
十月 '22
+35
在0个频道中
Get PRO
九月 '22
+44
在0个频道中
Get PRO
八月 '22
+45
在0个频道中
Get PRO
七月 '22
+43
在0个频道中
Get PRO
六月 '22
+46
在0个频道中
Get PRO
五月 '22
+35
在0个频道中
Get PRO
四月 '22
+56
在0个频道中
Get PRO
三月 '22
+47
在0个频道中
Get PRO
二月 '22
+42
在0个频道中
Get PRO
一月 '22
+41
在0个频道中
Get PRO
十二月 '21
+32
在0个频道中
Get PRO
十一月 '21
+49
在0个频道中
Get PRO
十月 '21
+42
在0个频道中
Get PRO
九月 '21
+35
在0个频道中
Get PRO
八月 '21
+49
在0个频道中
Get PRO
七月 '21
+57
在0个频道中
Get PRO
六月 '21
+44
在0个频道中
Get PRO
五月 '21
+44
在0个频道中
Get PRO
四月 '21
+41
在0个频道中
Get PRO
三月 '21
+49
在0个频道中
Get PRO
二月 '21
+75
在0个频道中
Get PRO
一月 '21
+59
在0个频道中
Get PRO
十二月 '20
+873
在0个频道中
日期
订阅者增长
提及
频道
17 九月0
16 九月+1
15 九月+1
14 九月0
13 九月+1
12 九月+1
11 九月0
10 九月0
09 九月0
08 九月0
07 九月0
06 九月0
05 九月0
04 九月0
03 九月0
02 九月0
01 九月+1
频道帖子
Documentation generation with AI takes under a minute. It reads naturally, matches the tone of your docs — and is wrong in th
Documentation generation with AI takes under a minute. It reads naturally, matches the tone of your docs — and is wrong in three places, because the ticket behind it was overridden by a decision no one wrote down. That's not an AI problem. It's a timing problem. The decisions that shape documentation (terminology, defaults, edge cases) get made during requirements and design. Documentation usually gets attached to testing and release, long after those decisions are already settled. AI removed the friction of writing. It did nothing about access to reliable information. If accurate info only exists after release, AI just produces plausible-sounding misinformation faster — and support bots reproduce that error at scale. We laid out a practical model: where writers need early access to specs, and where it isn't worth the disruption. Read the full article

2
Release notes usually get written last, under time pressure, by whoever's left in the room. A dev tries to remember what ship
Release notes usually get written last, under time pressure, by whoever's left in the room. A dev tries to remember what shipped. A PM fills gaps from memory. Someone turns "fix: null pointer in auth" into something a user can read (five minutes before the release goes out.) None of that needs to come from memory. It's already in your commits, PRs, and issue tracker. A commit like fix(auth)!: handle expired tokens tells you exactly what changed and whether it's breaking. Tools like semantic-release can turn a history of these into a changelog automatically. What automation still can't do: decide if a "feat" commit is something users should hear about, or whether five performance commits are really one story worth telling. 👉 Full story here
103
3
Two dictionaries just picked "slop" as their word of the year. In documentation it looks different: a portal that doubled in
Two dictionaries just picked "slop" as their word of the year. In documentation it looks different: a portal that doubled in size over a year while support tickets stayed flat. New on our blog: why cheap writing killed scoping, what happened at Snowflake after they cut ~70 tech writing roles right after a 30% revenue year, and the 6 questions nobody's left to ask anymore. Full piece here
180
4
Ask machine translation to handle the same product term twice, and there's no guarantee it comes back the same way. Multiply
Ask machine translation to handle the same product term twice, and there's no guarantee it comes back the same way. Multiply that across a documentation set, and one button ends up with three different names in three different languages. We sat down with Alconost to talk through where this actually comes from — and why the fix isn't a smarter MT engine. It's a maintained termbase with an owner, real review, and a process that keeps up when the product changes. Real incidents included: a core product term that came back as a compound word that doesn't exist in the target language, and a single bad string that spread through a translation memory badly enough to break a client's build. 👉 Full story
206
5
Wrote up a comparison of 10 docs-as-code tools: free and commercial. The short version: MkDocs if you want something running
Wrote up a comparison of 10 docs-as-code tools: free and commercial. The short version: MkDocs if you want something running in an afternoon, Docusaurus if you need versioning, Antora if your docs are spread across multiple repos. For managed hosting, Read the Docs is the most mature option. Swimm is in a different category — it's less about publishing and more about keeping docs accurate as code changes. Full breakdown is here
189
6
New in ClickHelp this August 👇 Readers can now plug their own AI agent (Claude, Cursor, ChatGPT, Gemini) straight into your
New in ClickHelp this August 👇 Readers can now plug their own AI agent (Claude, Cursor, ChatGPT, Gemini) straight into your published docs — the Published Docs MCP Server reads your current content and answers only from what's actually there, not a guess or an outdated training snapshot. Search also got smarter: AI Overview answers questions right in the results, and you can keep asking follow-ups without leaving search. Smaller but useful: Watch + version history are now in the Next Reader UI, and Quick Publish shows you the full list of topics before you hit publish. ✍🏼 Full Release Notes
168
7
Another one on content reuse — this time about snippet management. Short version: if the same warning or install step is copy
Another one on content reuse — this time about snippet management. Short version: if the same warning or install step is copy-pasted across 20 topics, and every product change means editing all 20 by hand — that's the sign it should be a snippet instead. We go through the difference between variables (values: version number, email, company name) and snippets (blocks: procedures, warnings, legal text), what's actually worth turning into a snippet vs. what should stay inline, and how to keep a snippet library from turning into a pile of note1, temp_block, and snippet_new. 👉 Read the full article
154
8
Technical documentation has a text problem — not too little text, but text doing jobs it's not good at. Describing a multi-ta
Technical documentation has a text problem — not too little text, but text doing jobs it's not good at. Describing a multi-tab configuration wizard in prose takes 200 words and still leaves users guessing what the screen looks like. A 90-second screencast answers the same question and gets out of the way. The article breaks down when each format earns its place: - Screencasts work when the workflow is short, stable, and UI-heavy. - Automated capture (Scribe, Tango, iorad) wins when the product changes often ( updating one step is faster than re-editing a full video.) - Full video makes sense for onboarding and training where production quality matters. The part worth noting: video without a transcript is a dead end for search. Users type questions into search boxes, not video players. Text stays the primary layer — multimedia just fills in what text can't show. 👉 Read the full article
166
9
Claude writes well. But without access to your actual data, it's writing in a vacuum. MCP fixes that. One server, and any com
Claude writes well. But without access to your actual data, it's writing in a vacuum. MCP fixes that. One server, and any compatible client (Claude, Cursor, Windsurf) can reach your tools and data without a custom connector for each one. We wrote a step-by-step guide to building a local MCP server in Python: — project setup with uv — a working tool with @mcp.tool() in 30 lines — local testing with MCP Inspector before touching Claude Desktop — the claude_desktop_config.json file and where to find it — the most common failures: wrong path, missing uv, vague docstrings For technical writers: the guide ends with a pointer to ClickHelp's MCP server — which gives AI agents direct read/write access to your documentation portal. 👉 Read the full guide here
178
10
Docs aren't just read by people anymore. So we tested how AI handles them. We ran a quick test: gave ChatGPT a link to one of
Docs aren't just read by people anymore. So we tested how AI handles them. We ran a quick test: gave ChatGPT a link to one of our documentation pages and asked it to summarize what it was about. It opened the link, read the page, and answered in seconds. No extra steps. Small result, but a good reminder — docs today get opened by more than just people. Search engines, AI assistants, link previews in Slack and LinkedIn all try to do the same basic thing: open a link, get something useful back. Read the full story
158
11
DITA is powerful. But does your team actually need it? Topics, maps, reuse, single-source publishing — it all works. Just com
DITA is powerful. But does your team actually need it? Topics, maps, reuse, single-source publishing — it all works. Just comes with an XML editor, a publishing engine, a CCMS, and months of setup. For a 3-person team with one product: almost always overkill. For 20+ authors, five languages, and regulatory requirements: almost always worth it. Between "Word doc chaos" and "full enterprise CCMS" there's a whole spectrum of tools that don't get talked about enough. We broke it all down — structured authoring explained, tools compared (DITA OT, Paligo, Heretto), and a practical guide to picking the right setup for your team size and workload. 👉 No fluff
177
12
Ever nodded along when someone said "send me the BRD" — and then quietly Googled what that actually means? New article breaks
Ever nodded along when someone said "send me the BRD" — and then quietly Googled what that actually means? New article breaks down five core product documents: MRD, BRD, PRD, Tech Spec, and User Stories. What each one is, who writes it, when it appears — and how they all connect in a real SaaS product example. Plus: three scenarios at the end (startup, agile team, enterprise) so you know exactly which docs your situation actually calls for. 👉 Read
190
13
📢 New in ClickHelp: multiple documentation sites, one portal If you publish docs for more than one product, brand, or audien
📢 New in ClickHelp: multiple documentation sites, one portal If you publish docs for more than one product, brand, or audience, this one's for you. You can now run several independent, public-facing documentation sites from a single ClickHelp portal. Authors manage everything centrally — but each site appears as a fully separate website to readers, with its own custom domain, branding, home page, and set of publications. How teams are using it: ▪️ A dedicated site per product or product line ▪️ Separate brands for different markets ▪️ A public Support Center + a developer knowledge base with API docs The feature is in public beta — try it for free. Message us and we'll set up a sandbox where you can build a few sites with your own content, with no impact on your live portal.
167
14
Regular expressions are one of the most powerful tools for technical writers — yet often underused. They can turn hours of ma
Regular expressions are one of the most powerful tools for technical writers — yet often underused. They can turn hours of manual editing into seconds: - bulk replace patterns, - clean markup, - extract data, - and automate repetitive documentation tasks. If you work with large docs, APIs, or structured content, regex is a skill worth mastering. 👉 Read the full guide here
208
15
📄 Google Docs works great when documentation is small. A few guides. A few contributors. A few updates. But things change wh
📄 Google Docs works great when documentation is small. A few guides. A few contributors. A few updates. But things change when documentation grows across products, teams, languages, and publishing channels. Content gets duplicated, updates become harder to track, and maintaining consistency turns into a challenge. At that point, you start needing a more structured way to manage content. In our latest article, we compare Google Docs and ClickHelp, exploring why many growing documentation teams eventually move from document-based workflows to a dedicated CCMS. 👉 Read the full comparison
197
16
Something shifted in how technical writers think about video, and it's mostly because the editing part got a lot less painful
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 🎬
198
17
AI agents are no longer just “search tools for documentation.” Something more interesting is happening: they’re starting to a
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
153
18
Agent Assist software is quietly transforming modern customer service, not by replacing human agents, but by empowering them.
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
152
19
A user opens your product for the first time. Gets confused. Opens Google. Closes your app. Sound familiar? In-app help is wh
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
178
20
Most documentation portals are invisible to AI tools. Not because the content is bad. Because the platform serves HTML that A
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
180