KT

kwangtaeko/tgx-docent

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

1 stars 质量 66 趋势 16MIT

从源代码生成用户手册和屏幕列表。

概览

这是一个Claude Code插件,可以分析网页应用项目的源代码并创建**。如果需要,你可以自己启动应用,甚至添加**,以及HTML·README·PDF·导出为PPT。所有描述都保留源代码证据(file:line),并标注所有无法仅靠来源确认的内容为[需验证]。 这个示例是用这个仓库里的示例应用(fixtures/nextjs-sample)创建的。你可以用 npm run 演示来重建它。 在目标项目上运行 /docent。Docent显示屏幕列表,接收确认并分析屏幕。显示应用执行计划(安装和执行命令),批准后显示应用以捕获该计划。最后,创建输出。 - .docent/out/html/index.html — 介绍、屏幕列表、逐屏手册(捕捉和操作GIF)、工作流程 - .docent/out/README.md — 初学者介绍 README - .docent/out/User manual.pdf, .pptx — PDF,PPT(应要求。文件名应为output.title,无空格;英文默认为UserManual.pdf)- .docent/review.md — 需要检查的项目(写答案后再次运行/docent-analyze) - 交付:封面、目录、修订历史 - 交接:维护证据和原始文件 - 作品集:重点介绍和动图 在 .docent/config.yaml 中,选择语言(语言:ko | en)和颜色主题(output.theme:靛蓝 | 蓝色 | 翡翠 | 玫瑰 | slate)。在屏幕分析前确定语言(并用该语言写屏幕描述)。屏幕上显示的按钮名称和信息均原文引用,无翻译。 当代码变更时,只有切换为 /docent-update 的界面会再次被处理。

概述(AI 翻译)

英语

这是一个 Claude Code 插件,分析网页应用项目的源代码,创建屏幕列表、每个界面的用户专用手册、项目介绍和工作流程。如有需要,您可以自行启动应用并添加截图和操作GIF,以及 HTML·README·PDF·导出为PPT。所有描述均保留来源证据(파일:줄),并表示无法单独通过来源确认的内容为[확인 필요]。

屏幕手册 工作流程

例如,将导师扫描应用于音乐学院学生预订 PWA(Next.js,NeoMusic)的五个学生屏幕。该应用无法在没有数据库或登录的情况下访问,因此截图取自存储验证模型(使用实际组件和 CSS 制作的屏幕),大小相当于手机(capture.device: mobile。实际应用的捕捉和操作 GIF 可以使用本报告中的示例应用运行。

安装

在目标项目上运行/docent。Docent显示屏幕列表,接收确认信息并分析屏幕。显示应用执行计划(安装和启动命令),一旦同意,启动应用以捕获该计划。最后,创建输出。

更新

Docent 每天会检查一次 GitHub 是否有新版本,如果有,当 [init ·build 收到通知时,它会通过更新命令通知你。它只读取公开版本文件,不会发送任何信息(关闭:DOCENT_NO_UPDATE_CHECK=1。要直接更新,请在终端中运行下面的链接,然后重启 Claude Code 或运行 /reload-plugins。你也可以在市场设置中的 /plugin 菜单中启用自动更新。

交付成果

  • .docent/out/html/index.html — 介绍、屏幕列表、按屏幕手动(捕捉与操作GIF)、工作流程
  • .docent/out/README.md — 首次访客介绍 README
  • .docent/out/사용자매뉴얼.pdf, .pptx — PDF/PPT(应请求。文件名应为output.title,并去除空格;英文默认为UserManual.pdf)
  • '.导览员/评论员。

本页由 AI 翻译,技术细节请以原文为准。

推荐工具

换一个关键词,或者移除筛选条件。

安装

npx skillfish add kwangtaeko/tgx-docent
新手?先看 mcpskill.org 教程 →