用途:为 Elastic 文档页面生成或改进 YAML frontmatter 中的 description 字段,以提升搜索引擎可发现性,并符合 Elastic 的写作约定。
主要能力:接收 $ARGUMENTS 作为文件路径或目录,若为目录则处理其中所有 .md 文件,若为空则询问用户目标。处理每个文件时读取其 frontmatter 与正文前约 30 行,判断页面用途后再撰写 description,并根据文档类型采用不同句式:教程以 Step-by-step tutorial for 开头;故障排查页以 Troubleshooting guide for 开头;参考页将 reference 自然融入句子;操作流程页直接以动作开头,不加标签前缀;概览与说明页先写功能作用与价值。
约束条件:描述最长 200 字符;语气以行动与价值为导向、客观、非人称;不使用 “you can”“users can”“this page explains”;使用完整句子;用 with [feature/tool] 明确范围;仅用纯文本,不能包含 frontmatter 中不会被解析的 Jinja2 变量;禁用词包括 teaching、enable、disable 及居高临下或排他性表述;不写版本号;description 冒号后不得再出现冒号,以免破坏 YAML 解析;每条描述必须唯一。同时禁止使用带连字符的标签前缀,也禁止使用片段式短语。
使用方式:对每个文件按读取、识别文档类型、检查是否已有 description、按约束与类型模式撰写或改写、校验长度不超过 200 字符、编辑 frontmatter 的顺序执行;处理目录时跳过描述已完整的文件,只改缺失或质量不佳的。完成后汇总更新文件(含旧到新描述对照)、已跳过文件与仍缺描述的文件。
适用场景与限制:适用于 Elastic 文档仓库的 .md 页面 frontmatter 维护。仅面向该文档体系,具体命令、安装方式及运行环境资料中未提供。