GLEP 51: Gentoo 知识库

搜索功能

作为良好知识库的主要功能之一，所使用的搜索引擎应该允许使用自然语言查询，因为这些查询更易于人们使用。然而，清晰简洁的“复制粘贴”查询也应该非常有效，因为许多问题都源于错误消息。

内容定义

内容最多的主题将是问题类型主题，这些主题描述了特定错误并告知用户解决方法。为了确保这些问题足够具体（而不是“如何修复构建错误”），它们必须彻底描述以下方面

• 标题 对问题进行了足够好的描述，大多数用户可以快速了解主题是否与他们相关。它也显示在搜索结果中
• 摘要 提供有关错误的更多详细信息，例如完整的错误消息、触发错误的命令或特定命令的（错误）行为
• 环境 告知用户主题何时适用。如果用户的环境与主题不匹配，则主题对用户无效。
• 在分析 部分，将详细考虑错误的原因，以发现触发错误的基本缺陷。它作为信息部分，供用户了解错误的原因。
• 为了修复错误，解决方案 部分引导用户完成解决问题所需的步骤。

第二种查询类型将是简短的（但有趣的）常见问题解答。这些答案简短而精确，通常是一两段。

虽然许多主题将特定于 Gentoo，但我们不会将自己局限于此。但是，我们不会添加特定于非 Gentoo 发行版的主题。

反馈系统

知识库应该允许用户反馈。诸如“这是否回答了您的问题？”之类的反馈对改进搜索结果非常宝贵，而“将此主题标记为已过期”则有助于我们保持知识库的良好状态。

我们可能需要考虑允许用户评论：它们可以为主题添加宝贵的信息，允许主题维护者使用更准确的信息更新主题。

主题维护系统

每个主题都应该由一名了解情况的开发者维护。系统必须允许开发者关注其主题并在需要时更新它们。当然，与特定代码库相关的主题应该由负责该代码库的团队维护。

虽然不是必需的，但修订历史记录会很棒 :-)

许可

知识库的内容应该是公有领域。任何大到需要不同许可证的内容都不应该包含在知识库中。