专注于文档(征集提案)

尚无读者喜欢。
Typewriter in the grass

原始照片作者 jetheriot。由 Rikki Endsley 修改。CC BY-SA 2.0 许可。

没有人欣赏好的文档。相反,好的文档只是存在于那里,回答问题,解决问题,默默地发挥着它的作用。而糟糕的——或者完全缺乏——文档,你才会注意到。

在开源社区中,软件和其背后的开发者往往受到赞誉,而文档——如果存在的话——则被视为事后诸葛亮,这真的很可惜。好的(或坏的)文档的力量不应被忽视。

今天我们启动了Doc Dish,这是一个新的社区专栏,专注于文档,我们正在寻找贡献者。

我们的第一篇文章由 Rich Bowen 撰写,基于他的一个会议演讲。最近在奥斯汀的 ApacheCon 上看到他演讲后,我忍住了站起来鼓掌的冲动。相反,我请他帮助我们启动这个专栏,这促成了他的文章:《RTFM?如何编写值得阅读的手册》。

正如你在他的文章中看到的那样,Rich 本身并没有接受过文档方面的培训,但他已经创建和改进文档几十年了,并且对这个主题进行了深入思考。他解释了文档如何说明你的项目和社区。例如,即使是写得很好的文档,也可以传达关于在其上工作的人员类型(不是类型)的信息。他还展示了像错误消息这样小的东西也属于文档的范畴。他的文章还提供了一些技巧和指向其他资源的链接,所以一定要看看。

如果您或您的项目想为新的文档专栏投稿,请给我们发送电子邮件,提交文章提案,附带简要大纲和作者简介。如果您对如何提交文章有疑问,或者需要更多信息,请告诉我们。请记住:好的文档就是好的思考。

文档

话题



本文是 Rikki Endsley 协调的“文档话题”专栏的一部分。要为该专栏投稿,请提交您的故事想法或通过 open@opensource.com 联系我们以获取更多详细信息。

User profile image.
Rikki Endsley 是红帽公司的开发者项目管理编辑,曾任 Opensource.com 的社区架构师和编辑。

评论已关闭。

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