记录是一段旅程：记录Scribus可获得3课

我想将自己的个人历程与开放源代码文档一起使用，来说明如何从零开始到零开始，然后创建并继续您的工作和其他工作。

我参与的项目是Scribus ，这是一个桌面发布（DTP）应用程序，用于创建PDF以在打印或网页中发布。 大约10年前，当我开始为该项目做贡献时，我对它一无所知，因此花了一些时间阅读并与邮件列表进行交互，以加深对如何使用它的理解。 一开始，我问了很多愚蠢或无知的问题，导致了一些更聪明的问题，而且一段时间之后，我知道了足以回答其他人的问题。

随着邮件列表不断涌入新用户，很容易看到一遍又一遍地询问相同或相似的问题。 似乎我们-我已经开始感觉到该项目的一部分-可以在某个地方提供这些预期的问题及其答案。 结果是创建了一个Wiki，供用户设置以为其他用户提供文档。 最初，Wiki是作为非官方信息源创建的，但是随着时间的流逝，Wiki以拥有用户想要的可靠，实用的信息而闻名。 对我而言，Wiki成为了实践写作文档，结合图像以增强文本的测试平台，最重要的是，它进一步了解了Scribus。 像大多数Wiki一样，Scribus Wiki允许我们编写自己的页面并进行编辑和添加到其他页面，以改善用户体验。 那时和现在的大部分灵感都来自邮件列表，无论何时我们发现用户无法找到所需的内容时，要么启动新页面，要么将旧页面更新。

在2008年左右，我们注意到有关是否有人可以拿到手中的文件（换句话说，是一本真正的书）的反复询问。 在开始学习第一堂课后，克里斯托夫·谢弗（ChristophSchäfer）介入并帮助组织了一次真正的努力，以使事情变得更有条理和明智。 大约9个月后，结果就是Scribus，《官方手册》 ，为Scribus的1.3.3.x版本编写了400多页的手册。 这项工作最初是在Wiki的特殊部分完成的，然后导出到OpenOffice，以便可以应用样式，然后导出到Scribus以进行最终布局。 （我们认为使用其他一些DTP软件来创建Scribus手册将是一种牺牲。）

从那时起，我们就以手册为灵感，继续致力于修订和更新Scribus随附的在线手册，因此，在积极开发项目的过程中永远无法完成工作。 对于我来说，这确实是一个了不起的旅程。

得到教训

对于那些编写文档的人，以下是一些重要的课程：

1. 了解主题：除非您知道如何使用软件，否则不能充分地撰写有关软件的文章，而不仅仅是以一些琐碎的方式。 您不仅需要为此做自己的工作，而且还需要听取其他用户的意见，尤其是那些精通该软件的用户。 您将需要与开发人员进行交互，尤其是在添加新功能时。 同样，您将有机会报告错误或为修改或新功能提出建议。
2. 好的写作需要实践：就我而言，实践始于尝试解释邮件列表中的答案，然后为Wiki创建更通用的响应。 在此过程中，您会得到有关您所写的内容是否有意义，是否简洁，以及希望读者感兴趣的反馈。 您有机会并且应该发展自己的写作风格。 这是Christoph和我在使用官方手册时要做的大事，试图在整本书中保持相当一致的风格。 而且，当您浏览数百页时，还面临保持活泼的挑战。 出于写作目的而阅读有关写作的知识并没有什么坏处，这样您就可以成为自己和他人作品的更好的编辑。 好的写作就是在任何地方看到的好的写作。
3. 与他人一起工作会产生丰富的财富：我不知道如果没有他人的帮助，我是否有能力独自完成自己的工作。 此外，由于他们的想法和我一路收到的反馈，我做的工作更好。 我很高兴看到我的一些更好的Wiki页面被翻译成其他语言，这是您可以获得的最好的称赞之一。

请访问Scribus网站，以了解有关该项目的更多信息并查看在线文档 ，并且不要忘记Scribus内的手册。

翻译自: https://opensource.com/business/15/6/documentation-journey-scribus