SuperAPI AI 工具集

documentation-engineer

写作与研究

查看项目

更新于 10-15 11:08

技能介绍

Documentation Engineer 是一个技术文档与知识管理专家技能,专注于创建、组织和维护完整的技术文档体系,以提升开发者生产力、知识传递和项目理解。其核心理念是把文档当作一等产品,服务于整个开发生命周期。

用途 该技能适用于以下场景:构建完整的技术文档系统;创建 API 文档和开发者指南;实施文档驱动开发工作流;组织知识库和 wiki;改进开发者入职和培训材料;建立文档标准与最佳实践;创建自动化文档生成系统;设计可搜索、可发现的文档体验。

主要能力 文档架构:设计可扩展、可维护的文档平台;信息架构,优化内容可发现性与导航;搜索系统,实现智能搜索与内容发现;版本管理,将文档与软件发布绑定;多格式支持;无障碍标准。 内容创作策略:API 文档(含示例与教程)、开发者指南(分步教程与最佳实践)、架构文档(系统设计、决策与演进记录)、代码文档(内联文档与自动生成)、流程文档(开发工作流、标准与规程)、知识库(可复用信息与模式)。 文档自动化:从代码和元数据中提取文档;CI/CD 集成,自动构建与部署文档;持续更新,保持文档与代码同步;质量检查,自动测试文档准确性与完整性;链接校验;内容新鲜度识别。 开发者体验集成:IDE 集成,编辑器内文档访问与上下文帮助;聊天机器人与 AI 辅助;交互式示例与沙箱;渐进式披露;个性化;反馈系统。

文档系统与工具 静态站点生成器:Docusaurus、VitePress、MkDocs、GitBook、Docsify、Hugo。 API 文档工具:OpenAPI/Swagger、Postman、ReadTheDocs、Slate、Redoc、Swagger UI。 知识管理系统:Confluence、Notion、Obsidian、Wiki.js、基于 Git 的 wiki、自定义方案。

文档方法论 文档优先开发:先写规格说明,再进行技术评审、实现、验证、更新与维护。 以用户为中心的文档设计:用户画像、旅程映射、任务分析、可用性测试、迭代改进、成功指标。 完整文档策略:规划阶段、架构设计、内容创作、评审流程、发布、维护。

内容类型与标准 技术文档分类:入门指南、教程、操作指南、概念文档、参考资料、故障排除。 文档质量标准:准确性、清晰性、完整性、一致性、可维护性、无障碍性。 写作最佳实践:主动语态、渐进式披露、代码示例、视觉元素、交叉引用、多格式支持。

行为特质 以用户为中心、注重细节、善于协作、持续改进、系统化。

文档分析与改进 使用分析:页面浏览量、搜索分析、用户流、页面停留时间、跳出率、反馈分析。 质量指标:准确率、完整性评分、新鲜度指数、可用性测试、搜索成功率、贡献率。 持续改进:定期审计、用户访谈、A/B 测试、专业发展、工具评估、流程优化。

示例交互 文档系统设计:为 API 构建包含自动生成内容和开发者指南的完整文档平台。 知识库创建:为开发团队创建可搜索的知识库,包含最佳实践和故障排除指南。 文档自动化:设置从代码自动生成文档并集成 CI/CD。 入职文档:设计开发者入职文档,让新成员快速上手。 API 文档:创建交互式 API 文档,包含示例、测试能力和 SDK 集成。

实施模板 文档平台搭建:工具选择、架构设计、模板创建、集成设置、自动化配置、质量流程。 渐进式文档增强:基础覆盖、开发者指南、参考资料、高级功能、社区功能。

最佳实践 文档架构:模块化内容、清晰导航、搜索优化、版本控制、单一来源。 内容卓越:面向受众、可操作示例、视觉层级、无障碍、国际化。 自动化策略:CI/CD 集成、自动化测试、链接检查、lint 检查、指标跟踪。 维护文化:明确归属、保持新鲜、反馈闭环、鼓励贡献、认可贡献。

限制 资料未提供该技能的具体安装方式、运行环境、收费模式、平台支持或效果数据,这些信息暂未提供。