--- xml/htdocs/proj/en/glep/glep-0051.html 2006/08/16 19:25:14 1.1 +++ xml/htdocs/proj/en/glep/glep-0051.html 2006/10/10 20:25:14 1.2 @@ -8,9 +8,252 @@ --> - + GLEP 51 -- Gentoo Knowledge Base - + @@ -32,9 +275,9 @@ - + - + @@ -42,7 +285,7 @@ - + @@ -51,8 +294,8 @@
Title:Gentoo Knowledge Base
Version:0.0003
Version:1.1
Last-Modified:2006/06/15 19:32:36
Last-Modified:2006/08/16 19:25:14
Author:Sven Vermeulen <swift at gentoo.org>,
Type:Standards Track
Content-Type:text/x-rst
Content-Type:text/x-rst
Created:30-May-2006

-
-

Contents

+
+

Contents

-
-

Abstract

+
+

Abstract

To improve the self-healing abilities of the Gentoo users, we have to offer a -repository with specific solutions to specific issues and quick answers to +repository with specific solutions to specific issues and quick answers to common questions which aren't global enough to fit within a Gentoo Documentation Guide. Such a repository can be offered by a Gentoo Knowledge Base.

-
-

Motivation

+
+

Motivation

When we look at the software projects today, we find that information has broadened beyond documentation and the detail level has deepend to an almost individual, precise answer for every question. It is no longer reasonable to @@ -97,17 +340,17 @@ and should leave no room for different interpretations. General topics must provide direct links to the documentation.

-
-

Requirements

-
-

Search functionality

+
+

Requirements

+
+

Search functionality

As one of the major features of a good Knowledge Base, the search engine used should allow for natural language queries as those are easier for people to use. However, clear cut 'n paste queries should also prove to be very effective as many questions rise from error messages.

-
-

Content definition

+
+

Content definition

The topics with the most content would be the issue-type topics who describe a certain error and inform the user about the resolution. To make sure these issues are specific enough (not "how do I fix a build fault") they must @@ -130,11 +373,11 @@

A second type of queries would be small (but interesting) FAQs. These answers are short and precise, most of the time one or two paragraphs.

Although several topics will be Gentoo specific, we will not limit ourselves -to this. However, we do not add topics that are specific to non-Gentoo +to this. However, we do not add topics that are specific to non-Gentoo distributions.

-
-

Feedback system

+
+

Feedback system

The knowledge base should allow for user feedback. Feedback such as "Does this answer your question?" is invaluable to improve the search results whereas "Mark this topic as outdated" helps us keep the knowledge base in good shape.

@@ -142,23 +385,23 @@ information to the topic, allowing the maintainer of the topic to update it with more accurate information.

-
-

Topic maintenance system

+
+

Topic maintenance system

Each topic should be maintained by a knowledgeable developer. The system must allow the developer to watch his topics and update them when needed. Of course, topics related to specific herds should be maintainable by the team responsible for the herd.

Although not required, revision history would be great :-)

-
-

License

+
+

License

The content of the knowledge base should be public domain. Everything large enough to warrant a different license shouldn't be in the knowledge base anyway.

-
-

Frameworks

+
+

Frameworks

Based on the requirements, one or more frameworks will be chosen. These should of course be free software projects; if we can't find any set of frameworks that adheres to the requirements, the knowledge base project should build one @@ -168,17 +411,18 @@ maintained by the Infrastructure project. As such, the Infrastructure project has final saying on the frameworks used in the knowledge base.

- -