Communitygithub.com

poorvith-mp/skills-writing

15个面向专业及长文写作的智能体技能:技术文档、论文、书籍及营销文案。

skills-writing 是什么?

该技能包提供了一套专业的标准化操作程序(SOP)编写框架,专为人类操作员或AI智能体设计,以确保在高压环境下(如凌晨3点紧急操作)仍能零歧义、零猜测、零灾难性错误地执行流程。其核心是四步SOP架构:范围与前提条件、确定性编号步骤序列(每个步骤以主动动词开头,并提供可复制粘贴的命令)、可观测的验证与验收门控、以及明确的回滚与升级路径。技能包还提供了一个生产级SOP模板和已验证的数据库恢复示例,并包含一个反模式清单(如模糊指令、缺失回滚、未测试的应急流程),帮助用户规避常见陷阱。该技能适用于Claude Code、Cursor、Codex等AI编程助手平台,能够显著提升技术文档、运维手册、合规流程等长文写作的质量与可靠性。

兼容平台~Claude Code~Codex CLI~Cursor✓Antigravity
npx skills add poorvith-mp/skills-writing

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

SOP-编写:标准化操作程序指南

核心理念

标准化操作程序(SOP)不是理论性论文或理想化的政策文件。SOP是一份可供人类或AI操作员执行的、可实现的算法化运行手册。一份优秀的SOP设计目标是:让合格的操作员在凌晨3点极度压力下,也能零歧义、零猜测、零灾难性错误地执行流程。每一步都必须包含确定性输入、编号化的物理操作、可观察的验收标准以及明确的升级路径。


四步标准化操作程序(SOP)架构

步骤 1:范围、治理与飞行前准备

  1. 元数据与所有者头部:
    • SOP ID、版本(SemVer)、生效日期、评审频率(年度/双年度)、责任流程所有者。
  2. 严格的用途与范围边界:
    • 明确此程序涵盖的内容,以及不涵盖的内容。
  3. 前提条件与访问权限:
    • 在执行第一步之前,列出所需的凭证、VPN访问、软件包和环境变量。

步骤 2:确定性编号步骤序列

  1. 命令式、无歧义的动作动词:
    • 每一步都以主动动词开头:点击、运行、验证、复制、导出、检查。
    • 绝不编写被动的指导:"确保查看了日志。"
    • 应编写:"1. 打开 Datadog 仪表板 Prod-Ingestion。2. 检查图表 p99 Latency。3. 验证值低于 200ms。"
  2. 复制粘贴命令卫生:
    • 在围栏代码块中提供确切的 CLI 命令或代码片段。绝不让操作员猜测标志名称或参数。

步骤 3:可观测的验证与验收门控

  1. "我怎么知道它工作正常?"检查:
    • 每个主要步骤都需指定其预期输出:
      • "预期输出:终端显示 部署完成:12/12 个 Pod 健康。"
  2. 决策树与分支逻辑:
    • 清晰格式化条件逻辑:
      • 如果状态 == 200:继续执行步骤 4。
      • 如果状态 == 500:跳转到故障排除章节 5.1。

步骤 4:故障处理、回滚与升级路径

  1. 回滚运行手册:
    • 如果程序中途失败,提供精确的回滚命令,将系统恢复到安全基线状态。
  2. 升级 SLA 与联系人矩阵:
    • 如果无法在 15 分钟内完成程序,应在什么频道联系谁,以及什么严重等级。

交付物格式:生产级标准化操作程序(SOP-TEMPLATE.md)

# 标准化操作程序:生产环境热修复部署
*SOP ID:SOP-ENG-042 | 版本:v2.1.0 | 所有者:平台工程负责人*
*生效日期:[YYYY-MM-DD] | 评审频率:季度*

## 1. 用途与范围
本程序规定了在标准每周 CI/CD 发布周期之外,向生产集群部署紧急热修复的流程。

## 2. 前提条件与访问要求
- 生产 AWS IAM 角色 `arn:aws:iam::123456789012:role/EmergencyDeployer`
- GitHub CLI(`gh`)已认证并具有仓库写入权限
- 本地配置了 AWS CLI v2 和 `kubectl`

## 3. 分步执行序列

### 步骤 1:分支隔离与验证
1.  从 `main` 检出热修复分支:
    ```bash
    git checkout main && git pull origin main
    git checkout -b hotfix/SEC-[IssueNum]
    ```
2.  本地运行完整测试套件:
    ```bash
    npm run test:ci
    ```
    - *验收检查*:退出码为 0;所有测试套件通过。

### 步骤 2:构建并标记容器镜像
1.  触发自动热修复构建流水线:
    ```bash
    gh workflow run hotfix-build.yml -f branch=hotfix/SEC-[IssueNum]
    ```
    - *预期输出*:GitHub Actions 输出镜像摘要 `sha256:...`。

### 步骤 3:生产环境发布与金丝雀验证
1.  将发布应用到金丝雀 Pod 池(10% 流量):
    ```bash
    kubectl set image deployment/api-gateway api=ecr.internal/api:[Digest] -n production
    ```
2.  监控错误率 5 分钟:
    - 检查 Grafana 仪表板 `https://grafana.internal/d/canary-health`。
    - *验收门控*:5xx 错误率必须保持 < 0.01%。

## 4. 回滚与应急预案
如果金丝雀错误率超过 0.05%:
1.  立即回滚部署:
    ```bash
    kubectl rollout undo deployment/api-gateway -n production
    ```
2.  在 Slack `#incident-war-room` 频道通知事件指挥官。

## 5. 升级联系人
- **一级主要值守 SRE**:PagerDuty 排班 `sre-tier-1`
- **工程副总裁**:电话:[号码](如果中断超过 15 分钟则呼叫)

实战示例:数据库恢复 SOP

  • 背景:针对加密 PostgreSQL 数据库快照恢复的恢复运行手册。
  • 影响:通过逐步 SOP,一名夜班轮值的初级工程师在 11 分钟内恢复了意外删除的客户表,且数据零损坏。

验证清单

  • 每个过程步骤都以主动命令式动词开头。
  • 命令和代码片段完全可复制粘贴,语法精确。
  • 每个关键步骤均指定了预期的可观测输出。
  • 记录了执行失败时的显式回滚程序。
  • 升级联系人矩阵包含命名的角色和寻呼渠道。

反模式

  • 模糊指令:编写"正确配置网络"而不是提供确切的 IP 表或 YAML 配置。
  • 缺少回滚运行手册:解释如何推送变更,却不解释如果变更导致问题如何撤销。
  • 未测试的运行手册:编写了从未在暂存环境中进行过演练的紧急灾难恢复 SOP。

相关技能