跳到正文

可复制的文档模板

从操作指南、参考条目和翻译记录模板起草,并根据读者任务补齐内容。

操作指南模板

用于已有项目中的单个任务。替换标题、描述和正文中的任务信息。前置条件写入能让步骤成功的版本、权限和输入。若需要讲解一项功能的原理,可增加链接,让读者在需要时进入概念说明。

---
title: 动词开头的任务名
description: 一句话说明读者完成后会得到的结果。
---

## 前置条件

列出已安装的工具、支持版本、运行目录和需要准备的输入。

## 执行步骤

1. 提供起步的动作和位置。
2. 写出实际命令或要修改的值。
3. 描述需要观察的反馈。

## 验证结果

给出可复现的检查步骤和预期输出。

## 遇到问题时

按实际现象给出检查和恢复办法。

配置或 API 参考模板

用于解释读者能按名称查询的对象。根据配置项参考和 API 条目规范选择字段。

---
title: 公开名称
description: 说明调用或配置这个对象会改变的行为。
---

## 用途与可用版本

交代所属文件或模块、引入版本和适用范围。

## 类型与行为

写出签名、输入类型、默认值、取值限制和返回值。

## 示例与验证

给出最小输入、可复制的调用和预期输出。

## 错误与边界

说明触发条件、错误码和处理方式。

翻译或上游同步记录模板

用于 PR 描述,便于审阅者回到同一版本。保留上游差异流程所用的比较端点。

## 上游基准

记录原文仓库、路径和比较的两个提交。

## 中文页更新

列出页面、术语、链接和需要单独说明的改动。

## 已验证

记录预览路径、示例运行环境和观察结果。

## 待核对

说明需要确认的术语、版本或上游问题。

提交前确认

按审阅清单核对正文、链接、代码、截图和机器可读的值。模板中的占位文字都应替换成读者可以判断和验证的内容。