字节-陈秋利-开发者体验驱动-上百个研发工具的知识管理实践

字节跳动开发者体验驱动 上百个研发工具的知识管理实践 陈秋利 字节跳动-基础架构产品运营 www.top100summit.com 目录 www.top100summit.com 目录 1.关于知识管理 什么是知识管理？为什么需要知识管理 2.知识管理的具体实践 项目背景介绍 具体策略 核心实践 3.启示 www.top100summit.com 开发者体验 质量 •谷歌-“codelab”的网站，提供了一系列的新手引导教程 效率 什么是知识管理 www.top100summit.com •定义（来源oracle） 知识管理指在组织中创建、共享、使用和管理信息。这是一种多学科的方法，通过向每个人提供正确的知识来实现组织目标。知识管理是企业创建、策划、分发、使用和管理知识和信息的方式，让所有人都能获得知识。 为什么要做知识管理 www.top100summit.com 试想一下：一个工具缺少基础知识会遇到什么？ •不清楚它做什么？ •如何才能上手使用？ 对新用户 •不知道近期有什么变动？ •遇到的问题该怎么处理？ •团队分工是怎样的 •业务情况如何 效率提升 对老用户对团队内 www.top100summit.com 具体方案 项目背景介绍 www.top100summit.com •研发场景下，字节内部存在上百个工具，此中情况下用户的研发体验是一个很大问题。在去年的研发体系调研中，工具相关基础知识成为影响研发同学体验的主要因素。 •面向字节内部的研发场景下多个工具的标准化知识管理。 面对的挑战 www.top100summit.com •涉及上百个组件的文档 •个别组件平台功能复杂，文档达300+之多 数量大 •文档缺失严重 •国际化问题 •文档搜索问题 •文档更新不及时等 质量问题突出 •团队仅不足10人，需要看护上百个组件文档 人力不足 建设思路 www.top100summit.com 手册结构 写作原则 元素规范 内容结构 质量等级划分 定标准 获取输出 消费&运用 反馈&迭代 文档知识沉淀流程 消费对接流程 反馈处理流程 产品经理 研发 技术支持 TW 产品侧入口 Oncall渠道 文档站点 需求搜集闭环管理 问题工单闭环流程 输出 审核 翻译 发布 对接 测试 对外 FAQ沉淀流转流程 理流程 文档管理后台 文档消费前台 任务管理 多语言版本管理 权限管控 反馈渠道 内容呈现 工单流转 审核发布 基础能力 知识地图 多渠道对接 文档新鲜度 数据监控 内容搜索 建平台 划分批次，分阶段建设接入 整体节奏 定标准-文档质量标准 www.top100summit.com 整体结构 模版大纲 单文档结构 最新动态 什么是XX 产品介绍 快速入门 产品优势 用户指南 应用场景 最佳实践 场景问题 使用限制 API参考 基本概念 ......... 写作原则 •陈述事实原则 •用户导向 •………. 元素规范 •标题 •段落 •句子 •图片 •表格………. 易使用 易理解 易查找 理流程-文档管理流程 www.top100summit.com 文档工程师 运营等 产品经理 多角色 技术支持 研发 角色 主要职责 文档工程师 每个文档工程师负责多个产品文档，负责质量把控 产品经理 负责每个工具的文档输出 研发 负责一些技术架构等知识维护 运营 负责面向用户的公告、动态维护 技术支持 负责根据用户问题丰富细节内容 多角色贡献，文档工程师管理 理流程-文档管理流程 多角色发起 •版本发布 •重要通知 •用户反馈 多角色负责 初稿 •输出初稿 TW负责 •符合规范 •描述优化 多角色 •优化后是否准确 TW •再次审核 TW负责 •对外开放 TW负责 •英文翻译 TW负责 •对外开放 www.top100summit.com 需求确认优化审核定稿发布翻译翻译发布 理流程-用户反馈流程 www.top100summit.com •将多渠道的反馈统一收揽，生成任务跟进，保证不被遗漏 •任务跟进根据不同的类型设置SLA，定时提醒。 文档中心 具体工单 oncall 聚类分析 生成任务 任务跟进 多用户 问答社区 www.top100summit.com 建平台-文档新鲜度管理 发布版本触发 数据记录 •结合版本发布流水线保证文档更新，将文档更新作为线上版本发布环节，保证文档新鲜度 添加卡点到流水线 收到文档更新任务 完成更新进行标记 www.top100summit.com 建平台-数据应用进行质量看护 数据采集搭建 基础数据 PV UV 文档数 调用次数 反馈数据 点赞 /点踩 反馈工单数 Oncall反馈 质量数据 英文覆盖率 文档新鲜度 工单闭环率 Oncall拦截率 数据监控 超30天未更新 工单处理超时 Oncall拦截率波动 英文覆盖度低于基线 数据晾晒 月度榜单 www.top100summit.com 建平台-数据应用进行质量看护 •文档健康度大盘•基础数据 www.top100summit.com 平台建设-基于AI能力保证效率和体验 •知识沉淀：用AI智能总结能力进行问答总结，再沉淀到知识库 碎片化 AI 结构化 总结内容 •问题描述： •产生原因： •解决方案 Oncall群多人多轮问答 智能总结 修改优化 同步创建文档到知识库 平台建设-基于AI能力保证效率和体验 •知识消费场景：用AI智能问答能力进行多轮问答 精准回答 关联知识范围 www.top100summit.com 散落各处 智能问答 Oncall拦截知识搜索个人助理 www.top100summit.com 启示和展望 启示 www.top100summit.com “流动的知识才是有价值的” 展望 www.top100summit.com •AI在知识沉淀上更多的应用： •根据PRD文档初稿输出 •文档翻译 •根据反馈文档优化 微信官方公众号：壹佰案例关注查看更多年度实践案例