Files
Endorphin-Document/authoring/templates/TPL-02.md

1.2 KiB

TPL-02 任务指南

用途:有明确前提的读者完成一项操作。适用规则:DOC-001、002、004、009、010、012、021。

内容顺序

# 完成某项任务

说明起点、目标结果和适用场景。

## 前提

列出已具备的声明、权限、输入与使用环境。
若入口尚未定义,说明本页是逻辑用法而非可运行操作教程。

## 步骤

1. 准备必要输入。
2. 编写当前步骤的声明或调用。
3. 使用结果完成目标。

每一步仅提供需要的解释和可观察核对点。

## 验证结果

说明成功值或效果,以及验证所用环境和等级。

## 常见边界

按原因、可观察情况和可用处理方式组织。
未定的错误处理语法明确链接状态,不给虚构补救代码。

## 相关任务

连接必要参考和邻近任务。

执行真实性

没有定义的安装、入口、官方引用或读取成员不能为“完整教程”补造。只有真实验证过的操作才使用“执行后输出”等表述;提案使用“预期结果”。

完成条件

目标结果可核对,步骤前提明确;读者不需猜测中间缺失的信息。

模板目录