Repolode
提交项目
SupportPages-io

SupportPages-io/wtfm

为 Claude Code 和 Codex 提供的插件，根据项目源码编写用户帮助文档，并用项目自身样式渲染截图。

在 GitHub 查看官网
Star
121
Fork
10
未关闭 Issue
7
最近提交
前天

这是什么？

WTFM 是一个面向 Claude Code 和 Codex 等编码智能体的插件，用来编写面向终端用户的文档，包括操作指南和故障排查说明，适合不懂代码却需要使用产品的人阅读。智能体会读取相关源码，从代码中获取路由、按钮文字和操作流程，再用通俗语言写出步骤。

文档中的每个界面都配有截图。WTFM 会根据项目自身的标记、样式和品牌元素重建界面模型，并在本地无头 Chromium 中渲染为 PNG，无需运行应用或手动截图。文章以 Markdown 文件夹形式保存，图片与文章放在一起，保存前还会经过结构、文案和截图检查。

工具在本地运行，使用你自己的智能体订阅。发布到 SupportPages.io 是可选的，只有在你选择时才会进行。支持 macOS 和 Linux，Windows 用户可通过 WSL 使用。

核心功能

  • 01根据项目源码编写操作指南和故障排查文章。
  • 02基于项目自身的标记、样式和品牌元素渲染截图，无需运行应用。
  • 03输出普通 Markdown，图片与每篇文章存放在一起。
  • 04保存前检查文章结构、文案和截图。
  • 05通过一次性安装命令与 Claude Code 或 Codex 配合使用。

适用场景

  • 为找不到某项功能的客户编写操作指南。
  • 记录管理员任务，例如邀请团队成员或修改设置。
  • 为帮助中心制作带插图的故障排查文章。
  • 把用户文档与产品代码保存在同一个代码仓库中。

快速上手

  1. 1

    运行 README 中的官方安装脚本

  2. 2

    设置你的电脑

    wtfm setup
  3. 3

    设置你的项目

    wtfm init
  4. 4

    在项目中让 Claude Code 或 Codex 撰写文章

使用前须知

  • 仅支持 macOS 和 Linux；Windows 用户需要使用 WSL。
  • 需要已安装并登录 Claude Code 或 Codex，并安装 Git。
  • 截图所需的 Chromium 会在首次运行 setup 时下载。

收录于专题

Claude Code 工具、技能与插件开源 AI Agent 框架与应用AI 编程助手与编码 Agent命令行与终端工具静态网站生成器与文档工具

标签

#ai-agents#technical-writing#documentation#user-documentation#screenshots#claude-code#markdown#cli#codex#help-center

常见问题

wtfm 是什么？
为 Claude Code 和 Codex 提供的插件，根据项目源码编写用户帮助文档，并用项目自身样式渲染截图。 WTFM 是一个面向 Claude Code 和 Codex 等编码智能体的插件，用来编写面向终端用户的文档，包括操作指南和故障排查说明，适合不懂代码却需要使用产品的人阅读。智能体会读取相关源码，从代码中获取路由、按钮文字和操作流程，再用通俗语言写出步骤。
wtfm 可以免费使用吗？用的什么许可证？
wtfm 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。
wtfm 还在维护吗？
活跃维护中。wtfm 最近一次提交是在 2026年11月5日。
wtfm 适合用来做什么？
为找不到某项功能的客户编写操作指南。 记录管理员任务，例如邀请团队成员或修改设置。 为帮助中心制作带插图的故障排查文章。 把用户文档与产品代码保存在同一个代码仓库中。
wtfm 怎么安装和运行？
运行 README 中的官方安装脚本 设置你的电脑: wtfm setup 设置你的项目: wtfm init 在项目中让 Claude Code 或 Codex 撰写文章
在哪里获取 wtfm？
源代码和安装说明在 GitHub 上：https://github.com/SupportPages-io/wtfm

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目