technical-writing - 专业技术写作赋能开发者文档
专业技术写作,专注于开发者文档、API 参考、README 文件和教程。
标签
更新于: 2026-03-23能力
典型输入
典型输出
该技能可以做什么
- 编写 README 文件
- 创建 API 参考文档
- 构建教程
- 编写概念指南
- 搭建文档流水线
- 自动生成 API 参考
- 集成文档构建到 CI/CD
- 维护版本化文档
- 审计现有文档
- 定义文档标准
- 创建贡献指南
- 衡量文档效果
输入
- 源代码
- 现有文档
- GitHub 问题
- 支持工单
- OpenAPI 规范
- JSDoc
- 文档字符串
输出
- README 文件
- API 参考文档
- 教程
- 概念指南
- 文档模板
- 贡献指南
- 迁移指南
- 变更日志
- 文档站点
要求
- 文件系统访问
- Shell 执行权限
- 文档框架
