生成清晰、全面的技术文档操作流程,注重准确性和逻辑性。
批量导入功能SOP编写操作流程(面向技术写作者) 目标 - 产出一份可操作、可审计、可恢复的《批量导入功能SOP》,聚焦于操作路径、业务规则、异常处理与恢复步骤四个核心部分。 - 确保信息准确、术语一致、步骤可复现,并已通过验证与评审。 1. 明确范围与读者 - 读者:一线运营、实施、客服、技术支持;次级读者为开发与测试。 - 覆盖环境:生产、预生产/测试环境的差异说明(如数据脱敏、访问权限)。 - 输出物:SOP文档大纲(含操作路径、业务规则、异常处理、恢复步骤四大章节)。 2. 信息采集与证据来源 - 文档资料:产品PRD、设计稿、接口说明、数据字典、错误码规范、权限模型、审计/日志策略。 - 访谈对象:产品经理(业务规则),后端/客户端开发(校验与错误机制),测试(边界与异常场景),运维/数据库(性能、限流、回滚策略)。 - 取证要求:要求提供真实或匿名化样例文件、错误报告样例、系统日志片段、限额配置(文件大小、行数、QPS等)。 3. 操作路径取证与编写 - 走查步骤: 1) 在测试环境完整执行一次导入,录屏并截取关键界面(入口、模板下载、上传、映射、校验结果、进度、完成页)。 2) 固定化菜单与路径表达,例:菜单 > 数据管理 > 批量导入(以产品实际为准,不杜撰)。 3) 记录所有可见参数与选项:支持的文件类型、编码、分隔符、日期格式、字段映射策略、冲突处理选项。 4) 如支持API导入,补充API路径、鉴权方式、限流与重试头信息参考(不展开实现细节)。 - 文档产出(操作路径章节): - 入口路径与前置权限 - 导入模板下载位置 - 文件上传与预校验触发方式 - 字段映射与冲突策略选择位置 - 提交导入、进度查看、结果下载/通知路径 4. 业务规则梳理与结构化 - 字段级规则: - 必填/可选、数据类型、长度/精度、枚举值、正则/格式要求、默认值、去空格/去特殊字符策略。 - 记录级规则: - 唯一性约束、主键/业务键匹配策略、允许重复的条件、去重规则与优先级。 - 跨字段与引用完整性: - 依赖字段顺序、跨字段约束(如开始时间<=结束时间)、外键/关联对象存在性校验与延迟校验策略。 - 批次与性能限制: - 文件大小上限、行数上限、并发批次数、单批最大处理时长、限流与排队策略、异步/同步模式差异。 - 导入模式: - 仅新增、仅更新、插入或更新(Upsert)、软删除/恢复的可选项与默认行为。 - 权限与可见性: - 谁可导入、导入影响的数据可见范围、审批或审计要求。 - 审计与可追溯: - 记录哪些信息:操作者、时间、批次ID、来源文件、规则版本、影响记录数、结果文件/报告位置与保留时长。 - 文档产出(业务规则章节): - 以要点清单呈现每条规则,附1–2条样例(包含正例与反例),并标注规则生效位置(预校验/入库前/入库后异步校验)。 5. 异常场景枚举与分级 - 分级标准: - 文件级异常:文件无法解析、模板不匹配、编码错误、超过大小限制。 - 记录级异常:必填缺失、类型不符、枚举超集、唯一约束冲突、外键缺失、跨字段规则不满足。 - 系统级异常:网络中断、鉴权失败、超时、存储或队列不可用、服务降级/限流。 - 表达要求: - 每类异常包含:触发条件、系统提示或错误码格式、对导入进程的影响(跳过/中断/回滚)、用户可见信息与建议动作。 - 文档产出(异常处理章节): - 异常分类清单 - 对应的处理策略与用户指导语(避免实现细节,但确保操作可执行) - 错误报告样例说明:列示列头、错误位置标注方式、错误信息字段含义 6. 恢复步骤设计与验证 - 记录级恢复: - 导出失败记录、修正后二次导入;支持部分重试时,说明如何选择失败记录重试。 - 批次级恢复: - 批次重跑条件、如何关闭已挂起的批次、如何更换新文件并保留同一批次编号或生成新编号。 - 断点续传与幂等: - 支持断点续传的前提与步骤;幂等键的定义(例如业务主键+时间戳/版本),避免重复写入的策略与识别方式。 - 回滚与补偿: - 全量回滚触发条件、部分回滚限制、无法回滚时的补偿流程(人工脚本、运营规则说明)、审批与审计要求。 - 告警与升级: - 失败阈值与触发告警条件、通知对象与渠道、升级路径(运营→值班→开发)。 - 文档产出(恢复步骤章节): - 针对常见失败路径给出端到端可执行的恢复指引(含前置条件、步骤、结果判定、注意事项)。 7. 验证与试运行 - 测试数据集: - 正常样例、边界样例(最大行、最长字段、极值日期等)、典型异常样例(各类错误至少1例)。 - 复现实操: - 按文档步骤操作,确保零歧义可复现;记录与文档不一致的点并更正。 - 规则对照: - 建立“规则-测试用例-结果”对照清单,确保每条业务规则至少被1个用例覆盖。 - 输出物: - 试运行记录、问题清单、修订后的SOP草案。 8. 写作与呈现规范 - 语言:客观、指令化、避免模糊词;首次出现的术语需定义。 - 结构: 1) 适用范围与前置条件(含权限) 2) 操作路径与步骤(图文并茂,截图标注关键控件) 3) 数据与模板规范(字段要求与样例) 4) 业务规则(分层次罗列,附正反例) 5) 异常处理(分类、影响、用户可执行动作) 6) 恢复步骤(记录级、批次级、回滚、断点续传、幂等) 7) 审计、日志与结果报告(存放位置、保留时长) 8) 常见问题与限制 9) 版本与变更记录 - 可用性要求: - 所有路径与按钮名称以产品实际为准;截图脱敏;提供示例文件下载链接位置说明。 9. 评审、签署与发布 - 评审角色: - 产品(业务正确性)、开发与测试(规则与错误机制)、运维/安全(权限、审计、回滚)、一线团队(可操作性)。 - 评审方式: - 走查用例对照、演示一次端到端导入与恢复。 - 签署与发布: - 记录评审结论与责任人;发布到知识库/帮助中心;标注生效版本与下一次复审时间。 - 变更管理: - 建立文档版本号与变更日志,功能变更时同步更新SOP与测试样例。 10. 附件与模板(建议随文提供或链接) - 导入模板示例文件(空模板与已填充的示例) - 错误报告样例(含字段说明) - 规则-用例覆盖清单 - 术语表与字段字典快照日期 - 操作检查清单 附:编写检查清单(聚焦四大核心) - 操作路径 - 是否提供明确入口与全流程步骤 - 是否标注权限与环境差异 - 是否可凭文档独立完成一次导入 - 业务规则 - 字段、记录、跨字段、批次、权限、审计是否覆盖 - 是否有正反例、边界条件 - 默认行为与可配置项是否明确 - 异常处理 - 文件级、记录级、系统级是否分类完整 - 每类异常是否有提示样例、影响描述、可执行应对动作 - 恢复步骤 - 记录级重试、批次重跑、断点续传、回滚/补偿是否具备可执行步骤 - 幂等与去重策略是否说明 - 告警与升级路径是否清晰 注意 - 不臆测不存在的功能项;不虚构错误码与限制。如信息不确定,标注“以实际系统配置为准”,并在评审前补全。 - 所有样例基于测试验证,保证可复现。
Authoring procedure for Module A documentation: Usage Instructions, Environment Preparation, and One-Click Deployment (including Dependencies, Configuration, and Rollback) 1) Purpose Provide a structured, repeatable process to produce three deliverables for Module A: - Usage Guide - Environment Preparation Guide - One-Click Deployment Manual (including dependencies, configuration, and rollback) 2) Roles and inputs - Stakeholders: product owner, tech lead, DevOps/Release engineer, QA, security - Inputs: - Source repo and build artifacts - Current deployment scripts or pipelines - Configuration files and schema (e.g., YAML/JSON) - Dependency list and versions - Architecture and network diagrams - Runbooks, incident history, and known issues 3) Writing process overview 1. Define scope and audience: target roles (end users, operators, SREs), supported platforms, and deployment targets. 2. Inventory facts: verify versions, supported OS/CPU, ports, services, third-party dependencies, and configuration keys. 3. Prototype the procedures: perform clean-room installs and deployments to validate steps and gather accurate output, timings, and screenshots if applicable. 4. Draft using the templates below; keep tasks atomic and step-driven. 5. Technical review: SME verification for accuracy and completeness. 6. Usability test: a non-author runs the docs end-to-end on a fresh environment. 7. Finalize, version, and publish with change log and cross-links. 4) Style and conventions - Use imperative, numbered steps for procedures. - One action per step; put expected results after the step. - Provide exact commands, flags, file names, and paths. Show sample outputs and exit codes where relevant. - Use consistent naming for placeholders: {{PARAM_NAME}}. - Call out risks and irreversible actions with a clear Warning. - Keep platform differences explicit and separated by headings (Linux, Windows, macOS). - All versions must be pinned (no latest). 5) Document templates (outlines) 5.1 Usage Guide for Module A - Title and scope: what Module A does; supported versions and platforms. - Prerequisites: environment, access, credentials, permissions, installed clients/SDKs. - Quick start: 1) Obtain/install Module A. 2) Minimal configuration. 3) Run a basic scenario. 4) Verify success (sample output/health endpoint). - Concepts overview: architecture at a glance, key components, data flow. - Interfaces: - CLI usage: commands, options, examples, exit codes. - API usage: base URL, auth, endpoints, request/response examples, error codes. - SDK usage: initialization, common calls. - Configuration basics: essential keys and recommended defaults. - Common tasks and recipes: start/stop, status, logs, rotate keys, backup/restore user data (if applicable). - Troubleshooting: common errors, causes, resolution steps, log locations, diagnostic commands. - Security considerations: secrets, least privilege, network exposure, TLS guidance. - Glossary and references: link to Environment and Deployment manuals. 5.2 Environment Preparation Guide - Supported platforms and versions: OS, CPU, container runtimes, orchestrators, cloud regions. - System requirements: - CPU, RAM, disk, IOPS - Time sync, NTP - File descriptor/ulimit needs - Network and security: - Required outbound/inbound ports and protocols - Proxy/SSL interception considerations - Firewall rules and security groups - Allowed domains/endpoints for dependencies - Dependencies: - Language runtimes/interpreters and exact versions - Package managers and repositories - System libraries, drivers, kernel modules - External services (DB, cache, message bus), including version constraints - Accounts and permissions: - Service accounts and roles - Required OS groups/capabilities - Secrets management (vault or KMS) - Storage and data: - Directories, ownership, permissions, SELinux/AppArmor notes - Backup locations and retention - Preflight checklist: - Verify OS version - Verify disk and memory - Verify ports not in use - Verify repository access and TLS trust - Verify credentials and keys available - Validation steps: - Run dependency check script - Confirm connectivity to external services - Record environment fingerprint (versions, checksums) 5.3 One-Click Deployment Manual (with dependencies, configuration, rollback) - Audience and scope: operator/SRE; environments covered (dev/stage/prod); idempotent runs. - Architecture overview: deployment topology and components. - Packaging and artifacts: - Artifact names, versions, checksums - Registry/repo locations and access - Configuration: - Configuration schema: each key with type, default, allowed values, example - Configuration sources: files, environment variables, secrets - Environment overlays (dev/stage/prod) and precedence rules - One-click execution: - Inputs: required variables, credentials, inventory/target hosts - Command to run and expected duration - What the script does at each phase: preflight, provision, configure, start, verify - Output and logs location; exit codes and meanings - Dependencies and migrations: - Database or schema migrations and their ordering - External service readiness checks - Post-deploy verification: - Health endpoints, smoke tests, synthetic transactions - Roll-forward decision criteria - Rollback plan: - Triggers (failed health checks, key step fails, regression) - Rollback types: binary/config revert, data/migration rollback, feature flag disable - Recovery time objectives (if applicable) - Step-by-step rollback procedure - Post-rollback verification and incident capture 6) Dependency and configuration documentation standards 6.1 Dependency list format For each dependency include: - Name and purpose - Required version (pinned) - Source/repository and checksum/signature method - Platform compatibility - Licensing notes (if distribution is required) - Health check/validation command - Known incompatibilities 6.2 Compatibility matrix - Module A version vs. OS version vs. dependency versions. - Note any required kernel parameters or container runtime flags. 6.3 Configuration schema format For each key: - Key path/name - Type (string, int, bool, list, map) - Required (yes/no) - Default - Constraints (regex/range/enumeration) - Description and impact - Sensitive (yes/no) - Example value - Change scope: runtime or restart required - Backward compatibility notes 6.4 Secrets handling - Never store secrets in plain text docs or repositories. - Reference secret names/paths (e.g., vault paths). - Document rotation procedures and TTL. 7) Rollback strategy documentation standards - Pre-deployment: require backups or snapshots for any stateful components; record artifact versions and checksums; capture migration plans with up/down scripts. - Decision tree: - If deployment fails before service start → revert binaries/config only. - If after start and schema changed → apply down migration and revert binaries/config. - If data transformations are non-reversible → restore from backup or snapshot; document data loss risks. - Rollback steps must include: - How to locate the previous good release (artifact and config) - Stop services safely (drain traffic, quiesce) - Revert artifacts and configs atomically - Apply database down migrations or restore snapshot - Clear caches if needed - Start services and run verification - Record incident and perform root-cause capture 8) One-click deployment script requirements and structure 8.1 Functional requirements - Non-interactive by default; support dry-run mode. - Idempotent: safe to re-run. - Fails fast with clear exit codes. - Writes structured logs and a machine-readable summary. - Performs preflight checks and environment validation. - Supports environment selection (dev/stage/prod). - Supports rollback command or flag. 8.2 Safety requirements - No destructive actions without explicit confirmation or a force flag. - Validates configuration against schema before applying. - Verifies checksums/signatures of artifacts. - Uses least-privilege credentials. 8.3 Suggested structure (high level) - Parse inputs and environment - Preflight: OS/version, disk/memory, ports, dependencies, credentials, network reachability - Fetch artifacts and verify integrity - Render configuration from templates and secrets - Stop or drain existing services (when upgrading) - Apply database migrations (with backups) - Deploy artifacts; set permissions/ownership - Start services; register with supervisor/orchestrator - Post-deploy verification: health checks, smoke tests - Emit success summary; on failure, auto-invoke rollback routine 8.4 Logging and observability - Log file path and retention policy - Include timestamps, step names, target host, exit status - Emit key metrics: duration per step, retry counts 9) Validation and testing of the documentation - Run all procedures on a clean environment image. - Test across all supported OS/architectures. - Negative testing: intentionally break a dependency to confirm troubleshooting coverage. - Time each procedure and capture typical output. - Verify rollback works from each failure point. - Acceptance criteria: - A new operator completes install and deploy without external help. - All commands copy/paste cleanly and produce expected results. - Rollback restores the last known good state within stated objectives. 10) Review, versioning, and publication - Technical review by SME and DevOps; security review for secrets handling. - Version documentation alongside Module A releases; include a compatibility table. - Change log: what changed, why, and migration notes. - Publish to the documentation portal; ensure stable links and search indexing. - Attach downloadable artifacts: configuration samples, schema reference, preflight checklist, and one-click script. 11) Maintenance - Establish a doc owner and SLA for updates. - Include docs in release readiness criteria and CI checks (e.g., schema sync). - Schedule periodic link checks and environment re-validation. - Capture feedback from incidents and integrate improvements. 12) Checklists 12.1 Prewriting checklist - Audience defined - Supported platforms enumerated - Dependencies and versions confirmed - Access to environments and credentials arranged - SME contacts identified 12.2 Usage Guide completeness - Quick start works on a fresh environment - Each command/example tested - Error codes and log locations covered - Security notes included 12.3 Environment Prep completeness - System, network, and access requirements validated - Preflight checklist executable - Dependency verification steps included 12.4 Deployment and rollback completeness - One-click script documented with inputs and outputs - Preflight, deployment, verification clearly separated - Rollback triggers and steps verified - Post-deploy and post-rollback checks included Placeholders to use within documents - {{MODULE_A_VERSION}} - {{SUPPORTED_OS_LIST}} - {{ARTIFACT_REPO_URL}} - {{CONFIG_FILE_PATH}} - {{SERVICE_NAME}} - {{PORT_LIST}} - {{DB_CONNECTION_STRING_SECRET}} - {{HEALTH_ENDPOINT}} - {{ROLLBACK_ARTIFACT_VERSION}} This process enables accurate, complete, and testable documentation for Module A’s usage, environment preparation, and one-click deployment with explicit dependencies, configuration, and rollback procedures.
以下は、機能「注文同期」(Order Synchronization)のテスト計画を作成するための操作フローです。計画には、前提条件、用例(テストケース)一覧、再現手順、期待結果を含めます。内容は製品仕様に依存しない汎用プロセスとして記述しています。 1. 目的と範囲の明確化 - 目的: 注文データがソース系からターゲット系へ設計どおりに同期されることを検証する。 - 同期方式の確認: - 同期方向: 一方向/双方向 - トリガー: イベント駆動/スケジュール(バッチ)/手動再同期 - 粒度: 全量/差分(変更のみ) - 整合性モデル: 強整合/最終的整合 - 順序保証: あり/なし - 冪等性: リトライ時の重複防止の有無 - 非機能要件: SLA(遅延許容値)、スループット、最大遅延、可用性、監査・ログ、アラート - スコープ外: 例)決済ゲートウェイの機能検証は対象外 2. 前提条件の策定手順 2.1 環境と権限 - テスト環境の同定: ソース系/ターゲット系の環境URL、バージョン、設定 - アカウントとロール: 発行済みAPIキー、必要権限(読み取り/書き込み/管理) - 時刻同期: タイムゾーン、サーバ時刻同期(UTC基準) 2.2 データ・依存関係 - 依存システム: キュー/ストリーム(例: Kafka/SQS 等)、DB、外部API - 初期データ: 注文ステータス(例: 新規/確定/支払済/出荷済/取消/返金)、SKU、在庫、顧客、価格・税・割引、配送先 - 識別子とキー: 注文ID、外部キー、冪等性キー、バージョン番号(楽観ロック) - データ量: 小規模/中規模/最大想定 2.3 通信と可観測性 - ネットワーク要件: タイムアウト、リトライポリシー、バックオフ - ログ/メトリクスへのアクセス: 同期ジョブのログ、DLQ(デッドレタ)可視化、メトリクス(遅延、失敗率) - テスト補助: モック/スタブの準備、APIリプレイ、固定時刻/固定IDの仕組み 2.4 リスクと制約 - 重複イベント、順序入れ替わり、部分失敗、タイムゾーン差異、通貨/丸め、並行更新競合 - 障害注入可否(ネットワーク遮断、スロットリング) 3. 観点定義とカバレッジ方針 - 機能観点: 作成/更新/取消/返金/部分出荷/返品、行明細/配送情報/支払情報/割引 - データ観点: 同値分割と境界値(数量0/最大、価格0/高額、桁数境界、文字列長、特殊文字)、通貨、税率、タイムゾーン - 状態遷移観点: NEW→PAID→SHIPPED→CLOSED、CANCEL、REFUND、逆遷移不可の検証 - 例外観点: ソース障害、ターゲット障害、ネットワーク遅延/切断、スロットリング、タイムアウト、重複イベント、順序逆転 - 非機能観点: 遅延、スループット、バッチサイズ、再同期ジョブの完了時間、リソース使用 - セキュリティ/監査: 権限チェック、PIIマスキング、監査ログの完全性 4. テストデータ設計手順 - データマトリクスを作成: - 注文ステータス × 支払状態 × 配送状態 × 通貨 × 税/割引パターン × 行数(1件/複数/大量) - 境界データ: - 金額・数量の最小/最大、端数処理(四捨五入/切捨て)、長文住所、非ASCII文字、タイムゾーン跨ぎ(DST含む) - 異常データ: - 欠損フィールド、無効ID、重複ID、壊れた参照(SKU不在) - 冪等性検証データ: - 同一冪等性キーの再送、イベント重複 5. 用例(テストケース)一覧の作成手順 - ケースID体系: OS-機能-番号(例: OS-Create-001) - 各ケースに付与: 優先度(P0/P1/P2)、対象要件ID、前提、入力、期待、観測ポイント - カテゴリ例と代表ケース(抜粋例) - 正常系: - 新規注文の同期(最小項目) - 割引/税/複数行を含む更新 - 部分出荷の段階的同期 - バッチ差分同期(N件) - 例外系: - 重複イベントの受領(冪等性で1回だけ反映) - 順序逆転(更新→作成の到着)時の最終整合 - ターゲット側一時障害→リトライ成功 - 不正データ(必須欠損)→拒否とDLQ投入 - 再同期/リカバリ: - 全量再同期(不整合解消) - 部分リプレイ(特定期間) - 非機能: - スループットしきい値での遅延測定 - バックログ(大量滞留)からの追いつき時間 6. 再現手順の記述手順(テンプレート) - TC-ID/名称 - 目的: 検証対象の要件・仕様を明確化 - 前提: - 環境、アカウント、設定(フラグ/フィーチャートグル) - 初期データ(注文/在庫/顧客)。初期化スクリプト/SQL/Fixtureの参照 - ログ/メトリクスの確認方法(ダッシュボードURL、クエリ) - 入力/トリガ: - 実行API/イベント/ジョブ、パラメータ、ペイロード例 - 手順: - 操作を番号付きで記述(タイミング、待機条件、再試行、障害注入の方法) - 変動要素固定(現在時刻、ランダムIDの固定化) - 観測ポイント: - APIレスポンス、DBレコード、メッセージキュー、ログ、メトリクス、UI表示 - 後片付け: - ロールバック/データ削除、キューのクリア - 期待結果: - 具体的な検証項目(下記7章の基準を参照) - 判定基準: - Pass/Fail条件を定量的に記載 7. 期待結果の定義手順(判定基準) - データ完全性: - 注文、明細、支払、配送、金額(税/割引含む)が一致 - タイムゾーン換算、丸め規則の一致 - 整合性/順序: - 指定の整合性モデルに収束(最終的整合なら許容時間内に一致) - 順序保証/欠如に応じた最終状態の正当性 - 冪等性/重複排除: - 重複イベントや再送で二重反映なし - 例外処理: - 不正データは保存不可、エラーコード/理由が記録され、DLQ/アラートが発火 - 一時障害はポリシーどおりリトライされる - 非機能: - 遅延(p95/p99)およびスループットが要件内 - バックログ解消時間が要件内 - 監査/可観測性: - 監査ログに操作主体、時刻、変更差分が記録 - メトリクス(成功/失敗件数、遅延)とアラート閾値が有効 8. トレーサビリティとカバレッジ確認 - 要件トレーサビリティマトリクス(RTM)で各要件→テストケースを紐付け - カバレッジレビュー: - 状態遷移、境界値、例外、非機能の網羅 - リスクベース優先度: - P0(クリティカル経路/収益影響)、P1(頻度高)、P2(低頻度/代替あり) 9. ドキュメント化の形式(推奨テンプレート) - テスト計画(全体) - 目的/範囲/前提/環境/体制/スケジュール/リスク - テストケース一覧(表形式) - ID、タイトル、優先度、要件ID、前提、入力/データ、手順、期待結果、観測ポイント、後片付け、状態(未/実行/合否)、証跡リンク - データマトリクス - ステータス×通貨×税×行数×境界条件の組合せ - 証跡ポリシー - 必須スクリーンショット/ログ/クエリ/エクスポート 10. サンプル(最小例) - ケース: OS-Create-001 新規注文の同期(最小項目) - 前提: 環境E1、APIキーK1、商品SKU A1、顧客C1 - 入力/トリガ: ソースに注文作成APIを送信(通貨JPY、行1、数量1、税0) - 手順: 注文作成→キュー到達確認→同期ジョブ実行確認→ターゲット検索 - 期待結果: - ターゲットに同一注文IDで作成 - 金額/数量/通貨が一致 - 遅延p95 ≤ 要件(例: 5秒) - 監査ログに作成イベント記録 - ケース: OS-Idem-002 重複イベントの受領 - 前提: 上記注文が存在、冪等性キーX - 入力/トリガ: 同一ペイロードを2回送信 - 期待結果: ターゲット側のレコードは1件のまま、重複は無視、ログに「重複扱い」を記録、DLQなし 11. 品質保証と維持 - レビュー: QA/開発/プロダクトで前提・期待の妥当性確認 - 自動化方針: 高優先度の正常/例外/冪等性/回帰ケースを自動化 - 回帰セット: スキーマ変更/同期方式変更時の最小必須セットを定義 - バージョニング: 計画、ケース、データスクリプトの版管理 - 実行後: 逸脱・欠陥の分析、ケース更新、カバレッジ再評価 12. チェックリスト(抜粋) - 前提条件: 環境/権限/可観測性/時刻同期/データ初期化が完了 - 用例一覧: 正常/異常/非機能/再同期/冪等性/順序/セキュリティを網羅 - 再現手順: 変動要素固定、依存の明示、手順は一意に追従可能 - 期待結果: 定量基準を含む(遅延、件数、状態、ログ、DLQ、アラート) - トレース: 全要件に紐付け、優先度設定済み この手順に従うことで、注文同期機能のテスト計画(前提条件、用例一覧、再現手順、期待結果)を、仕様に整合し、再現性と判定可能性が高い形で作成できます。
将新功能操作路径、业务规则与异常处理沉淀为SOP,统一口径,支撑评审、发布与对外说明。
把模块使用、环境准备与部署步骤转为可执行手册,减少口头传达和返工,加速新人融入项目。
标准化测试计划与复现步骤,自动输出前置条件与预期结果,便于回溯问题并提升协作效率。
快速产出常见问题指南与排错路径,多语言同步,缩短响应时间并降低培训与沟通成本。
沉淀安装、变更与故障处理流程,明确风险与回退方案,确保多地交付一致可追溯。
将课程实验步骤、操作图示与知识库文章标准化,一次编写,多渠道分发与版本管理。
用一条标准化、可复用的提示词,让 AI 充当资深技术写作者,面向真实业务场景,快速产出“清晰、全面、可执行”的操作流程文档。通过结构化提问与输出,帮助你: - 把复杂步骤讲清楚:逐步说明、配套前置条件、所需材料、注意事项与校验点 - 降低风险与返工:覆盖常见错误、排查路径、回滚方案与版本记录 - 统一团队标准:固定格式与用词口径,减少个人差异导致的质量波动 - 多角色与多语言适配:可按新人/专家/客户/内部使用者的理解深度与场景调整说明,并支持中英等多语言输出 - 快速沉淀知识资产:将零散经验转化为可发布、可传承的操作指南,减少重复沟通与支持成本 适用场景:新功能上线、安装与配置、排障流程、数据与权限变更、交接与培训、客户交付与服务手册等,帮助团队缩短文档定稿周期、提升交付质量与客户满意度。
将模板生成的提示词复制粘贴到您常用的 Chat 应用(如 ChatGPT、Claude 等),即可直接对话使用,无需额外开发。适合个人快速体验和轻量使用场景。
把提示词模板转化为 API,您的程序可任意修改模板参数,通过接口直接调用,轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。
在 MCP client 中配置对应的 server 地址,让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作,让提示词在不同 AI 工具间无缝衔接。
免费获取高级提示词-优惠即将到期