SuperAPI AI 工具集

claat-writer

前端与建站

查看项目

更新于 10-15 18:37

技能介绍

用途:把项目源码、README、配置文件、既有文档、步骤备忘、日志、URL 等素材整理成 claat 可识别的 manual.md 手顺书。核心成功标准是读者中途不停顿地走到最后。

主要能力与流程:先读素材,只写能确认的命令、路径、版本与输出,未确认的标注“(未确认)”或向用户确认;再明确读者、到达点与前提;然后按“1 步骤=1 个可验证的状态变化”切分,第一步固定为“目标与前提确认”,最后一步为“成果确认与联系方式”,Duration 用 H:M:SS 写实值(如 0:05:00);写作时一句一个动作、先写“在哪里”、专业词首次出现即解释、操作后写成功状态,代码只放可复现内容且不贴未验证命令,图片仅用于 GUI 操作对象识别与结果对照,存于 images/ 并用相对路径与说明性 alt。

可用的 claat 记号:aside positive / aside negative 提示框、<button> 下载按钮;What you'll learn 等英文标题下的列表会渲染为清单,日语标题不生效;表格、链接、列表按普通 Markdown。

限制与必做检查:claat-tools lint 较本体严格——Duration 必须三段式,代码围栏前须有正文且不能出现在 Duration 之前,最多用到 ####,# 标题仅一个,元数据固定 7 键,id 仅限 [A-Za-z0-9_-],environments 仅 Web/Kiosk,status 仅 Draft/Published/Deprecated/Hidden;模板为 assets/template.md。交付前必须做日语检查(可先 sed 's/^Duration:.*$//' manual.md > .prose-check.md 再调用 natural-japanese),修正后运行 go run github.com/nogikun/claat/cmd/claat-tools@v0.1.0 lint path/to/manual.md 直到退出码为 0,最后告知保存路径、未确认项与拍摄委托清单。未获委托不生成 HTML、不发布。