documentation-production
ChatGPT 技术文档技能:为开发者写教程、参考和文档索引
EnglishChatGPT 安装步骤
- 打开固定提交的 skills/documentation-production/SKILL.md,核对原文的输入和输出。
- 在 ChatGPT 打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 按下面的工作流程填写技能规则。使用对话内给出的代码、输入样例和可核实的已有文档片段。
- 保存技能,在新对话输入本页的虚构示例并核对结果。
中文摘要
先明确读者和文档类型,再用代码片段、现有文档及实际验证结果写教程或参考。补齐先决条件、预期结果和索引入口。
SKILL.md 中文导读
可复现示例
给新同事写虚构的 CSV 导入教程。材料说明必须有 email 列,空地址会跳过并计数。示例有两行,其中一行为空。请给教程和导航标题。工作步骤
- 确定读者和文档类型。
- 用源材料写步骤和预期行为。
- 对照样例核查结果,并为索引写准确标题。
验收方法
教程从准备 CSV 开始,给出可检查的输入与预期结果,保留一行成功、一行跳过,并给索引入口和术语表。
GitHub 原文 · 更新日期
适用环境
需要启用了技能创建的 ChatGPT 工作区。这里使用基于 GitHub 原文编写的文本改编。
常见问题
教程和参考页怎么区分?
教程围绕读者首次完成一项任务组织。参考页帮助查找字段、参数和边界,可从教程链接到参考页。