SuperAPI AI 工具集

write-korean-technical

写作与研究

查看项目

更新于 10-15 20:05

技能介绍

用途:按“读者与完成状态定义 → 实际环境确认 → 步骤与概念结构化 → 验证 → 文体检查”的顺序撰写韩语技术文档,覆盖开发者指南、安装文档、教程、API 说明、架构文档、ADR、运维手册、故障应对流程、排障指南、变更与迁移文档。

主要能力与要求:先明确读者技术水平与角色、要执行的任务或理解的概念、操作系统/运行时/版本与前提条件、输入输出与完成状态、失败时的回滚或诊断方法、可实际验证的范围。若提供仓库或运行环境,先确认实际文件、命令、版本与当前路径,不混淆源码默认值与运行中配置。保留函数名、API 路径、选项、环境变量、文件名与错误信息,不擅自改写;未执行的命令与未确认的结果不得写成成功;版本相关信息以当前环境或官方文档为准;区分已确认事实、合理推断与未验证假设;示例中不得包含密钥与真实凭据。文档类型从 references/formats.md 中选择。

使用方式:步骤文档每步同时给出行动与确认方法(行动 → 预期结果 → 失败时检查项);概念文档按功能、名称、工作方式、限制、示例的顺序说明,术语首次出现时定义并保持一致。需要文件产物时使用 assets/technical-document-template.md 并只保留必要章节,完成前应用 references/quality-gate.md。文体与结构检查命令: uv run "$CORE_SKILL_DIR/scripts/lint.py" path/to/document.md --genre tech uv run "$CORE_SKILL_DIR/scripts/outline.py" path/to/document.md uv run "$CORE_SKILL_DIR/scripts/terms.py" path/to/document.md 其中 CORE_SKILL_DIR 解析为与本技能同一上级文件夹下的 natural-korean 目录。代码、日志、命令与标识符不纳入文体修改。若无公共检查技能,则手动应用质量门并说明未运行检查。

限制:最终交付时需简要写明实际验证过的命令、环境与结果范围,未执行的步骤标注为未验证;面向读者的文档中不得保留内部推理或临时日志。