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 291
订阅者
-124 小时
-37 天
-1730 天
数据加载中...
相似频道
标签云
进出提及
---
---
---
---
---
---
吸引订阅者
七月 '26
七月 '26
+3
在0个频道中
六月 '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个频道中
| 日期 | 订阅者增长 | 提及 | 频道 | |
| 24 七月 | 0 | |||
| 23 七月 | 0 | |||
| 22 七月 | 0 | |||
| 21 七月 | 0 | |||
| 20 七月 | 0 | |||
| 19 七月 | 0 | |||
| 18 七月 | 0 | |||
| 17 七月 | +1 | |||
| 16 七月 | 0 | |||
| 15 七月 | 0 | |||
| 14 七月 | 0 | |||
| 13 七月 | +1 | |||
| 12 七月 | 0 | |||
| 11 七月 | 0 | |||
| 10 七月 | 0 | |||
| 09 七月 | 0 | |||
| 08 七月 | 0 | |||
| 07 七月 | 0 | |||
| 06 七月 | 0 | |||
| 05 七月 | 0 | |||
| 04 七月 | +1 | |||
| 03 七月 | 0 | |||
| 02 七月 | 0 | |||
| 01 七月 | 0 |
频道帖子
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
| 2 |  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 | 67 |
| 3 |  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 | 105 |
| 4 |  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 | 152 |
| 5 |  📢 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. | 134 |
| 6 |  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 |
| 7 |  📄 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 |
| 8 |  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 |
| 9 |  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 |
| 10 |  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 |
| 11 |  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 |
| 12 |  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 |
| 13 |  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 ✍🏼 | 215 |
| 14 |  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 | 186 |
| 15 |  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 | 200 |
