ChatGPT 工程文档规划技能:分配 README、架构说明和维护职责
EnglishChatGPT 安装步骤
- 从固定版本 GitHub 原文下载 engineer/engineer-toolkit/skills/documentation-strategy/SKILL.md。将它作为 documentation-strategy 的独立文本技能,保留名称、描述及正文。
- 在已启用技能和上传权限的 ChatGPT 工作区,打开「插件 → 技能 → 创建 → 从电脑上传」,选用文件选择器接受的技能包格式。也可在「使用编辑器创建」中录入原名称、描述和文本指令。
- 完成扫描后,确认 documentation-strategy 出现在已安装列表。在新对话输入 @ 并选择此技能,使用页面的虚构示例检查输出。
中文摘要
根据读者任务拆分项目文档,安排导航、文件负责人、更新触发条件和复核周期。适合已有说明散落在多个位置的项目。
SKILL.md 中文导读
可复现示例
虚构库存应用有 README、CSV 字段表和一次换数据库的决定。为新贡献者与值班同事各设计入口,列清楚每份文档何时更新。工作步骤
- 盘点现有文档和读者要完成的任务。
- 按快速开始、架构、接口、决策和运维分类建立入口。
- 为每项分配维护人、更新触发条件和审阅时间。
验收方法
README 提供快速上手和交叉链接,字段表在导入约定变动时维护,数据库决定用 ADR 保留背景,值班入口指向故障处置文档。缺少负责人时标待定。
GitHub 原文 · 更新日期
适用环境
需要有技能创建权限的合资格 ChatGPT 工作区,选择上传时还需相应权限。这份纯文本移植的安装路径按 OpenAI 文档核对,工作区运行待验证。
常见问题
已写在聊天里的技术决定适合放哪里?
把有持久影响的决策整理为 ADR,记录问题、选项、决定和影响,并从架构说明链接过去。