社区和文档

2020年5月29日星期五12:30 ET / 16:30 UTC | 30分钟

描述

在本节课中，学习为什么文档很重要，以及你可以如何做出贡献。好的文档基本上是看不见的。你有一个问题，你找到了答案，然后你立刻忘记了整个过程。然而，糟糕的文档是令人难忘的。最好的文档应该在用户提出问题之前回答他们的问题。文档可以设置上下文，并帮助确定如何理解和使用软件。文档应该反映常见的(和不常见的)用例。当问题得不到回答，或者回答得不好时，社区就会做出反应。这可以是任何事情，从沉默的愤怒到编写自己的竞争性文档来回答问题。真相应该只有一个来源。 Competing sources cause confusion and are extra effort. The great thing about open source is that our docs are your docs. If something is wrong or missing, file an issue. If you see something that can be improved, file a PR and fix it. The team appreciates any help you are willing to give, and future users with the same question will be grateful.

下载幻灯片

Diana Payton, Grafana实验室的高级技术作家bob电竞频道

戴安娜·佩顿(Diana Payton)是一名专门从事软件文档工作十多年的技术作者。目前，她是Grafana实验室唯一的科技作家，住在美国西海岸的俄勒冈bob电竞频道州。在她的空闲时间，她喜欢武术，遛狗，看书，写小说。