documentation 是一个帮助 AI 撰写与维护技术文档的 Skill。项目介绍、接口说明、操作手册或新人指南要写什么,先取决于读者准备完成哪件事。
新人打开 README,要知道项目做什么、如何开始和怎样配置;调用接口的人,需要请求与响应示例、认证及错误说明。处理故障的操作手册,则要写适用时机、前提权限、步骤、回退和升级求助路径。
它要求把最有用的信息放在前面,用命令、代码或截图说明实际操作,并保持内容更新。已有说明尽量链接,避免复制后不同页面逐渐出现两套答案。你提供目标读者、用途与项目事实,它给文档组织方向和正文;原文的快速上手时间是写作目标,不能当成已经验证的读者完成时间。