征集玩家排版_专用于文档(征集建议书)

征集玩家排版

没有人喜欢好的文档。 相反,好的文档只是存在 ,存在,回答问题,解决问题并悄悄地达到其目的。 另一方面,您会注意到糟糕的文档或完全没有文档。

在开源社区中,软件及其背后的个性往往会赢得荣耀,而文档(如果存在)只是事后的想法,这实在太糟糕了。 好的(或不好的)文档的力量不容忽视。

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

我们的第一篇文章是Rich Bowen的一篇基于他的会议演讲的文章。 当我看到他最近在奥斯汀的ApacheCon上发表演讲后,我抵制了站起来鼓掌的冲动。 取而代之的是,我请他帮助我们开始我们的专栏,这引起了他的文章: RTFM? 如何写一本值得一读的手册

正如您将在他的文章中看到的那样,Rich本身没有文档培训,但是几十年来他一直在创建和改进文档,并且为该主题提供了很多思考。 他解释了文档如何说明您的项目和社区。 即使写得很好的文档,例如,可以将消息发送什么样的人(不是 )进行这项工作。 他还展示了如何将错误消息之类的小问题归入文档保护范围。 他的文章还提供了许多技巧和指向其他资源的链接,因此请务必检查一下。

如果您或您的项目想为新的文档栏做贡献,请给我们发送文章建议,简短的概述和作者简介。 让我们知道您是否对如何提交文章有疑问,或者是否需要更多信息。 请记住:好的文档是好的想法。

文件


本文是Rikki Endsley协调的Doc Dish专栏的一部分。 要撰写本专栏文章,请提交您的故事创意或通过open@opensource.com与我们联系以获取更多详细信息。

翻译自: https://opensource.com/business/15/5/cfp-documentation-articles

征集玩家排版

  • 0
    点赞
  • 0
    评论
  • 0
    收藏
  • 扫一扫,分享海报

参与评论 您还未登录,请先 登录 后发表或查看评论
©️2022 CSDN 皮肤主题:编程工作室 设计师:CSDN官方博客 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值