账号与身份
成员入职离职、角色与权限分配、单点登录对接,都落在这条线上。权限配错导致看不到菜单,是最常见的求助。
常看的人:IT 管理员
82 篇
01
每条产品线的文档都在解决一类具体麻烦。看清自己卡在哪一类,后面的检索会快很多。
成员入职离职、角色与权限分配、单点登录对接,都落在这条线上。权限配错导致看不到菜单,是最常见的求助。
常看的人:IT 管理员
82 篇
多人同时编辑、历史版本回溯、审批流怎么串起来。稿子被谁改过、怎么退回上一版,这里都有步骤。
常看的人:业务负责人、内容运营
96 篇
指标怎么定义、图表怎么搭、报表怎么定时推到同事邮箱。数字对不上时,先从指标口径那几篇查起。
常看的人:运营分析、业务主管
88 篇
接口鉴权、回调地址、沙箱联调与错误码对照。第一次接通的完整链路,从一个可以跑通的最小请求讲起。
常看的人:研发工程师、集成方
74 篇
手机上怎么审批、离线时能看到什么、小屏排版如何收成单列。外勤同事的第一手问题多集中在这里。
常看的人:一线外勤、移动办公人员
62 篇
工单怎么提、响应时长怎么算、培训和迁移如何预约。遇到跨产品线的问题,从这里找对接人最快。
常看的人:客服主管、运维人员
78 篇
02
480 余篇说明按四个深度层级摆放。知道自己在哪一层,就不用从头翻到尾。
讲清一个概念是什么、第一个流程怎么跑通。刚接手项目、要给同事做交接时,从这一层开始最省时间。
把常用能力串起来用:模板复用、批量处理、多人协作的分工方式。已经上手、想提效率的人看这一层。
权限、字段、通知规则、接口地址这类设置项的逐项说明。改动会影响整个团队时,先对照这里再动手。
按报错现象组织:先看日志在哪、再看错误码怎么读,最后给对应的处理办法。运行中出问题先翻这一层。
03
鼎盛平台大陆版页面在正文上方提供一枚切换控件,点一下就在两种排版之间换过来,当前读到哪一篇不会丢。
MODE / TOC
左侧常驻一列层级目录,点开一级展开二级,正文区只显示当前这一篇。目录的展开状态和滚动位置会保留,来回比对两篇参数时不必反复往回找。
适合已经明确问题、要照着步骤边做边看的时候。比如配置单点登录,您需要的是那一篇参数说明,而不是整章通读。
MODE / ALL
整章内容按标题层级平铺在一页里,一屏接一屏往下滚。浏览器自带的页内查找在这里特别好用,搜一个关键词就能看到它出现在哪些段落。
适合新人交接、内部培训投屏,或者您想把一条产品线的能力全貌过一遍。一个地址就能把整章讲完,转给同事也方便。
04
从 2022 年起,移动端体验专项已经做了 6 轮全站适配改造。现场用手机查步骤、临时给客户演示,都不必再回办公室开电脑。
| 文档类型 | 建议读者 | 平均读完 | 更新频率 |
|---|---|---|---|
| 入门指引 | 新加入的成员 | 8 分钟 | 随双周版本 |
| 配置手册 | 团队管理员 | 15 分钟 | 随双周版本 |
| 接口参考 | 研发与集成方 | 20 分钟 | 版本发布后 3 日内 |
| 排障清单 | 运维与客服 | 6 分钟 | 按实际案例补充 |
05
小版本每两周迭代一次,文档与功能在同一天上线,最近一次是 7 月 10 日版本。您照着文档操作时,看到的就是当前版本的界面。
每一篇上线前,产品、文档、测试各查一遍:界面是否一致、步骤能否复现、边界情况有没有写漏。
功能上线当天,相关篇目同步更新;涉及权限或字段的改动,会在篇首标出影响范围。
重要变更写进内容中心的双周公告,注明涉及哪条产品线、改了哪几篇,方便您回查三个月前的说法。
发现写错或过时,从篇目底部的纠错入口提交即可,平均 3 个工作日内处理完毕并回复处理结果。
06
同一套文档,不同角色关心的部分差别很大。下面三条路线是大多数人验证过、见效最快的顺序。
NEW USER
大约两小时能读完这三组,够应付日常操作。
ADMIN
改配置前先看一眼进阶篇,能避免大半的返工。
DEVELOPER
沙箱环境和正式环境分开跑,联调阶段不容易踩坑。