词映 AI导航
工具库Skills 技能
我的收藏
词映 AI导航

ChatGPT 技术文档架构技能：按读者设计 README、指南和 API 参考

English

ChatGPT 安装步骤

  1. 打开固定提交的 skills/documentation-knowledge/SKILL.md，核对原文的输入和输出。
  2. 在 ChatGPT 打开「插件 → 技能 → 创建 → 使用编辑器创建」。
  3. 按下面的工作流程填写技能规则。提供项目目标、读者角色、现有目录和可用材料清单。
  4. 保存技能，在新对话输入本页的虚构示例并核对结果。

中文摘要

按评估者、新用户、集成开发者和贡献者的任务安排文档入口。用快速开始、参考、架构与决策记录覆盖不同的信息深度。

SKILL.md 中文导读

可复现示例

虚构开源工具同时面向新用户、API 集成者和贡献者。现有 README 塞入二十个 API 字段和历史设计理由。请给文档结构。

工作步骤

  1. 按读者任务分组现有内容。
  2. 把任务入口和详细参考放到合适页面。
  3. 列导航与每页负责回答的问题。

验收方法

README 保留价值、最小示例和导航，字段移入可查阅参考，设计理由归入 ADR。贡献者从贡献指南进入开发设置。

GitHub 原文 · 更新日期

适用环境

需要启用了技能创建的 ChatGPT 工作区。这里使用基于 GitHub 原文编写的文本改编。

常见问题

怎样判断内容该放教程还是参考？

读者需要按顺序完成第一次任务时用教程。读者要查字段、选项或接口行为时用参考，并加相互链接。

相关指南

相关推荐