SuperAPI AI 工具集

sister-script

办公与效率

查看项目

更新于 10-16 04:38

技能介绍

用途

Sister Script 是一种文档优先的自动化开发方法。它的核心主张是:文档是事实来源,脚本是文档的子产物。该技能用于把已经验证过的操作流程转化为自动化脚本,而不是一开始就编写脚本。它对应 play-learn-lift 流程中的 LIFT 阶段——只自动化已被证明有效的模式。

主要能力

  • 提供从自然语言到自动化脚本的渐进路径:先用自然语言描述(PLAY),再加入手动命令(PLAY/LEARN),然后记录可用的操作流程(LEARN),最后生成自动化脚本(LIFT)。
  • 支持文档与脚本的双向演进:已验证的流程变成自动化脚本;自动化过程中获得的洞见反过来改进文档。
  • 提供配套文件:SKILL.md 为完整方法论文档,PROCEDURE.md.tmpl 为流程模板,SISTER.yml.tmpl 为姊妹关系模板。
  • 推荐脚本遵循 sniffable-python 约定,使 LLM 能通过阅读 main() 理解 CLI,人类也能通过 --help 获得相同信息,实现文档的单一来源。
  • 强调目录无关调用:脚本必须能在任意目录下被调用,通过脚本自身位置而非调用者的工作目录来定位技能上下文。

使用方式

按照 play-learn-lift 的节奏推进:

  1. 用自然语言描述任务(PLAY)。
  2. 加入手动命令进行尝试(PLAY/LEARN)。
  3. 把可用的操作步骤记录成流程文档(LEARN)。
  4. 基于流程文档生成自动化脚本(LIFT)。

脚本结构建议遵循 sniffable-python 约定,例如 Python 脚本使用 argparse,并在 main() 中组织 CLI 结构,使文档字符串同时成为 --help 内容和 LLM 可读信息。

目录无关调用的实现方式:

Python 示例:

from pathlib import Path

SCRIPT_DIR = Path(__file__).resolve().parent
SKILL_DIR = SCRIPT_DIR.parent  # 如果脚本位于 skill/scripts/

CONFIG_FILE = SKILL_DIR / "config.yml"
PATTERNS_DIR = SKILL_DIR / "patterns"

Bash 示例:

#!/bin/bash
# tool-name: Works from any directory.

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SKILL_DIR="$(dirname "$SCRIPT_DIR")"  # 如果脚本位于 skill/scripts/

CONFIG_FILE="$SKILL_DIR/config.yml"
PATTERNS_DIR="$SKILL_DIR/patterns"

load_patterns() {
    for f in "$PATTERNS_DIR"/*.yml; do
        echo "Loading: $f"
    done
}

使用 __file__ 或 ${BASH_SOURCE[0]} 而非 $0 或 pwd,可以确保脚本在被直接执行或被 source 时都能正确定位自身位置。

适用场景

  • 需要把反复执行的手动流程沉淀为可复用自动化脚本的场景。
  • 希望文档与脚本保持同步、避免文档过时的团队或个人工作流。
  • 与 session-log、research-notebook 等技能配合,将日志和笔记中的流程转化为自动化。
  • 与 plan-then-execute 配合,脚本可以成为计划的一部分。

限制

资料未提供该技能的具体安装命令、依赖要求、支持平台、收费方式或性能指标。资料未提供除 Python 和 Bash 之外的其他语言示例。资料未提供该技能的实际运行效果或验证数据。