查看: 1270|回复: 2
收起左侧

[新组上路 Onboarding] 续 - 关于好好写doc

|只看干货
本楼: 👍   75% (3)
 
 
25% (1)   👎
全局: 👍   73% (6423)
 
 
26% (2265)    👎

注册一亩三分地论坛,查看更多干货!

您需要 登录 才可以下载或查看附件。没有帐号?注册账号

x
本人写了这个贴子
https://www.1point3acres.com/bbs/thread-910737-1-1.html
今天又看到这个https://www.1point3acres.com/bbs/thread-918757-1-1.html
想起来最近我身旁发生的小事,给大家记下来,再次强调doc的重要性。没有干货,就是流水账。

本人最近为组里设置一个服务,需要登陆某个系统。当时mentor,一个很耐心的前辈,给我一步步讲了如何configure,至少花了半个小时。但是有个问题:有个东西我没有权限,mentor本人也不清楚(毕竟他开权限也是好久之前了)。我搜了一段时间,找到了合适的人,然后设置好了。

我把整个的设置过程一步步写了doc,为了我之后交接的时候方便。

前几天听说,就在我设置之后,组里另一个新人需要同样的系统。那个mentor也是给他一步步讲如何做,那个新人碰到了同样的问题,不幸的是他没找到合适的人,block了好久,我的manager和skip manager在帮他问。我知道了之后,立马share给了组里doc,他也找到了联系方式。

结论:
1. 如果mentor把整个过程写下来,或者他的学生详细记了个doc,我mentor根本不用一遍遍地开会讲设置,每个新人,对他来说都可以省下30分钟的时间。而写doc,根本用不了很久(因为他在讲解的时候,有的步骤也要现想/有的平台比较慢/需要打command...)。
2. 正如 https://www.1point3acres.com/bbs/thread-918757-1-1.html,doc要非常详细,确保一个啥都不懂的也能一步一步做对。权限其实就是一封邮件的事,但如果不知道找谁就抓瞎了,导致后续无法进行。像我mentor,几年之后再想,可能就忘了该找哪个组了。
3. 新人,如果你们组里有个很能写doc的人,有事问问他,说不定有惊喜。

上一篇:想问问有没有2022年六七月办过export control license的朋友?
下一篇:狗家锄奸队必须带我一个
BZH 2022-8-12 09:05:16 来自APP | 显示全部楼层
本楼: 👍   100% (1)
 
 
0% (0)   👎
全局: 👍   94% (2588)
 
 
5% (155)    👎
这其实和refactor一样,如果一件事大概率以后要重复,就应该独立成一个方法,或者这里说的文档。don’t repeat yourself 不是最基本的要求吗?

评分

参与人数 1大米 +1 收起 理由
hunter3k16 + 1 insightful!

查看全部评分

回复

使用道具 举报

xchen10 2022-8-12 11:24:29 来自APP | 显示全部楼层
本楼: 👍   0% (0)
 
 
0% (0)   👎
全局: 👍   97% (601)
 
 
2% (17)    👎
有一份很详细的doc 真的很重要!有的doc 关键步骤都有,但前因后果一带而过,设置的时候还是很令人茫然
回复

使用道具 举报

hunter3k16 2022-8-13 13:09:00 | 显示全部楼层
本楼: 👍   0% (0)
 
 
0% (0)   👎
全局: 👍   100% (33)
 
 
0% (0)    👎
BZH 发表于 2022-8-11 21:05-baidu 1point3acres
这其实和refactor一样,如果一件事大概率以后要重复,就应该独立成一个方法,或者这里 ...
insightful!
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册账号
职场达人
  • ↑ 本版用于讨论职场各种干货话题,闲聊请去🔗聊聊或者🔗匿名版
  • ❌ 本版严禁水贴,引战,发布广告,拉群,贴个人联系方式,扣分无警告
  • ☑ 求职、面经等去 🔗北美求职和 🔗回国求职大区,刷题和学习请去 🔗终身学习大区
  • ☑ 请去专版发布 🔗内推, 🔗招聘信息,和讨论 🔗创业内容

本版积分规则

>
快速回复 返回顶部 返回列表