如何在 OpenStack 中成为一名成功的远程文档贡献者

Alexandra Settle 即将在巴塞罗那 OpenStack 峰会上进行的演讲预览
4 位读者喜欢这篇文章。
Sky with clouds and grass

Flickr 用户:theaucitron (CC BY-SA 2.0)

Alexandra Settle 是 Rackspace 的信息开发人员,她将在巴塞罗那的 OpenStack 峰会上发表演讲。Alexandra 是 OpenStack 手册的核心审阅者,也参与 OpenStack Ansible 和 Swift 项目文档的工作,并在 Outreachy 项目中担任文档导师。她从高中起就对信息技术感兴趣,并且是 Fedora Linux 的粉丝。她的职业生涯始于 Red Hat 的实习生,在使用 Windows 机器多年后,她喜欢使用 Linux 带来的易用性和功能性。

在这次采访中,Alexandra 分享了她在 她的演讲 中关于在家工作和在开源项目工作中成为优秀沟通者的最佳实践的预览。

制作优秀文档的秘诀是什么?

我不会说制作优秀文档有什么“秘诀”。优秀的文档很少出自一人之手——它始终是团队合作的成果。如果您撰写初稿,或者可能是文档的更新,协作是您成功的关键。您的原始文档应该始终有多人审阅,一位编辑(如果您的团队有)并且对于技术文档,应该始终有一位 SME(主题 matter 专家)提供指导。您不能对您的写作过于敏感。没有人是完美的,您的写作也不会是完美的。此外,当您与他人合作时,您会学到更多。

您如何保持读者对高度技术性文档的兴趣?

高度技术性的文档不是人们在睡前倾向于阅读的东西。幸运的是,我为开发人员和运维人员社区写作。安装指南、网络指南和升级指南 对他们的日常工作至关重要。但是,在过去几年中,我从支持人员、运维人员和开发人员那里收到的反馈相当一致——保持简单(但永远不要使用“简单”这个词:它永远不是简单的,并且它侮辱了那些不觉得简单的人)。技术文档应该告诉您做什么,如何做,以及在必要时提供一些背景信息。如果您将其保持在这些界限内,您的受众会欣赏您的输出。

我/我们应该在家工作的首要三个理由是什么?它如何同时既棒又糟糕?

您应该在家工作的三个理由

  1. 工作/生活平衡。 假设您与您的雇主或经理有良好的理解,您通常可以在与您的朝九晚五的同事不同的时间表上工作。它使您能够做一些简单的事情,而当朝九晚五工作时,这些事情可能会成为生活中一些痛苦的根源(例如,去邮局。当邮局总是在下班后关门时,这有多烦人!)。

  1. 您自己的空间。 我简直无法强调拥有自己的办公室、自己的舒适设施、食物以及不必为办公室盛装打扮的选择是多么美好。当您精神上感到满足时,它可以创造一个非常高效的环境。

  1. 加入联合办公空间。 对于任何愿意每周去办公室几天,但又不是“那个办公室”的人来说,这是一个很棒的主意。我加入了一个名为 The Swarm 的空间,它位于布里斯班的 West End。他们已不再运营,但这个美丽的空间是由建筑师翻新和设计的——他们实际上在楼上的空间工作。我能够结识各种创意人士和技术人员,他们都在从事各种各样的项目。这是一个绝佳的社交机会,如果您在办公室工作,您将无法获得这种机会,我将认真地将其推荐给任何人。

在家工作之所以很棒,是因为我上面列出的所有原因,自由感是朝九晚五的生活无法比拟的。但是,当您没有管理好自己的时间时,它可能会很糟糕。我遇到的最大的困难之一是缺乏社交。我是一个非常喜欢社交的人,但我发现在在家工作的头一年里,我与朋友见面的次数减少了,在“工作时间”之外花费更多时间在电脑上(不停地查看电子邮件,检查我对文档补丁的更改是否已合并,浏览 Buzzfeed,并变得越来越孤僻。这是一个非常难打破的循环。我的工作受到了我对生活缺乏热情的影响,在面对我的问题后,我能够重塑我对在家工作和工作/生活管理的看法。

这个 是对所有这些事情的相当准确的解释,我在我的 Linux Conf 演讲中使用过它。

当在家工作时,您如何维护您所工作的组织的文化?

这非常困难,但幸运的是,我与一个在家工作的团队一起工作。至少,文化是通过 Slack 或 IRC 等沟通平台来维护的(我个人偏好)。即使是通过文本媒介相互了解,也使团队能够培养内部笑话、典故,谈论电子邮件、工作,甚至可能是个人物品。至于维护组织的文化——这绝对是一项更艰巨的任务。根据经验,我会说维护您的组织文化的最佳方法是参与其中。无论是通过联系附近的办公室并组织访问,参加他们当地关于公司问题的会议(拨号或视频接入),还是加入社交委员会并报告您和您的团队的外部活动。例如,我们的在家工作团队在一个月发现悉尼办公室正在举办披萨午餐。我和另一位同事在 IRC 上发动了一场虚假的“政变”,并在与我们的老板谈判后,我们有了 2014 年的伟大的披萨订单。公平地说,这并没有变成披萨。但是,我们确实查看了我们的团队预算,我们能够为每个人组织特定城市的团队郊游以及午餐和电影。

Outreachy 如何帮助您成长?与 Outreachy 的实习生合作有什么优势?

Outreachy 为我提供了一个平台来帮助他人。虽然我真诚地喜欢教人并看着人们成长和学习——但我在这方面很糟糕。我,自认,非常不耐烦——这对于老师来说是一个可怕的品质。技术并不总是人们立即感到舒适的东西,这是非常可以理解的。通过导师/学员计划,我被教导(最肯定的是学员教导的)要有耐心——当您远程尝试通过 IRC(有时也通过语言障碍)教某人如何解决他们的问题时,这非常重要。向某人发送指向“让我为您谷歌一下”的链接不会为您赢得任何朋友。

多样性是与 Outreachy 实习生合作的主要优势。Outreachy 计划的最新一轮重点关注国际上的女性(顺性别和跨性别)、跨性别男性和性别酷儿人士。我有机会结识许多与我背景非常不同的人——这真是令人大开眼界。

User profile image.
教育家、企业家、开源倡导者、终身学习者、Python 教师。教育心理学硕士,教育领导学硕士,Linux 系统管理员。

2 条评论

很棒的文章,Alexandra 和 Don!虽然我喜欢与同事在会议中进行物理上的接近,但绝对我最高效的日子是我在家工作的日子。我很高兴能够灵活地两者兼顾。

谢谢 Jason!我也很喜欢在家工作。但是,见到同事本人总是很高兴。Skype、FaceTime 和其他虚拟会议确实彻底改变了对话方式。

回复 作者 Jason B

知识共享许可协议本作品根据知识共享署名-相同方式共享 4.0 国际许可协议获得许可。
© . All rights reserved.