Contents of /xml/htdocs/proj/en/glep/glep-0051.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations) (download) (as text)
Wed Aug 16 19:25:14 2006 UTC (12 years, 5 months ago) by liquidx
Branch: MAIN
File MIME type: text/html
adding glep 51 - kbase from swift

1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <!--
5 This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6 PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
8 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
12 <title>GLEP 51 -- Gentoo Knowledge Base</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14 </head>
15 <body bgcolor="white">
16 <table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0">
18 <tr><td class="navicon" width="150" height="35">
19 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td>
22 <td class="textlinks" align="left">
23 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24 [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25 [<b><a href="./glep-0051.txt">GLEP Source</a></b>]
26 </td></tr></table>
27 <table class="rfc2822 docutils field-list" frame="void" rules="none">
28 <col class="field-name" />
29 <col class="field-body" />
30 <tbody valign="top">
31 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">51</td>
32 </tr>
33 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Gentoo Knowledge Base</td>
34 </tr>
35 <tr class="field"><th class="field-name">Version:</th><td class="field-body">0.0003</td>
36 </tr>
37 <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0051.txt?cvsroot=gentoo">2006/06/15 19:32:36</a></td>
38 </tr>
39 <tr class="field"><th class="field-name">Author:</th><td class="field-body">Sven Vermeulen &lt;swift&#32;&#97;t&#32;gentoo.org&gt;,</td>
40 </tr>
41 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42 </tr>
43 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44 </tr>
45 <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td>
46 </tr>
47 <tr class="field"><th class="field-name">Created:</th><td class="field-body">30-May-2006</td>
48 </tr>
49 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">16-Aug-2006</td>
50 </tr>
51 </tbody>
52 </table>
53 <hr />
54 <div class="contents topic" id="contents">
55 <p class="topic-title first"><a name="contents">Contents</a></p>
56 <ul class="simple">
57 <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
58 <li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li>
59 <li><a class="reference" href="#requirements" id="id4" name="id4">Requirements</a><ul>
60 <li><a class="reference" href="#search-functionality" id="id5" name="id5">Search functionality</a></li>
61 <li><a class="reference" href="#content-definition" id="id6" name="id6">Content definition</a></li>
62 <li><a class="reference" href="#feedback-system" id="id7" name="id7">Feedback system</a></li>
63 <li><a class="reference" href="#topic-maintenance-system" id="id8" name="id8">Topic maintenance system</a></li>
64 <li><a class="reference" href="#license" id="id9" name="id9">License</a></li>
65 </ul>
66 </li>
67 <li><a class="reference" href="#frameworks" id="id10" name="id10">Frameworks</a></li>
68 <li><a class="reference" href="#copyright" id="id11" name="id11">Copyright</a></li>
69 </ul>
70 </div>
71 <div class="section" id="abstract">
72 <h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
73 <p>To improve the self-healing abilities of the Gentoo users, we have to offer a
74 repository with specific solutions to specific issues and quick answers to
75 common questions which aren't global enough to fit within a Gentoo Documentation
76 Guide. Such a repository can be offered by a Gentoo Knowledge Base.</p>
77 </div>
78 <div class="section" id="motivation">
79 <h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1>
80 <p>When we look at the software projects today, we find that information has
81 broadened beyond documentation and the detail level has deepend to an almost
82 individual, precise answer for every question. It is no longer reasonable to
83 suggest that documentation is sufficient to succesfully aide users with
84 exploring the world of software use. Documentation is a (and perhaps even the
85 most) powerful tool to guide users through complex topics. Yet documentation
86 mainly focuses on a large reader base. Whenever topics become too detailed, they
87 become difficult to fit inside a certain hierarchical structure.</p>
88 <p>Such a structure is required by users who need to find documentation quickly. A
89 major help is, of course, a search feature that spans all documentation.
90 However, when hundreds of (seemingly similar yet different) topics are
91 available, many search technologies fail. Natural language queries often express
92 more details than a regular, boolean expression, but not that many search
93 technologies allow such queries.</p>
94 <p>The Gentoo Knowledge Base is an effort to extend the information Gentoo delivers
95 with precise answers to specific questions. Each topic in the repository must be
96 owned by at least one knowledgeable developer, written in a structured manner
97 and should leave no room for different interpretations. General topics must
98 provide direct links to the documentation.</p>
99 </div>
100 <div class="section" id="requirements">
101 <h1><a class="toc-backref" href="#id4" name="requirements">Requirements</a></h1>
102 <div class="section" id="search-functionality">
103 <h2><a class="toc-backref" href="#id5" name="search-functionality">Search functionality</a></h2>
104 <p>As one of the major features of a good Knowledge Base, the search engine used
105 should allow for natural language queries as those are easier for people to
106 use. However, clear cut 'n paste queries should also prove to be very
107 effective as many questions rise from error messages.</p>
108 </div>
109 <div class="section" id="content-definition">
110 <h2><a class="toc-backref" href="#id6" name="content-definition">Content definition</a></h2>
111 <p>The topics with the most content would be the issue-type topics who describe a
112 certain error and inform the user about the resolution. To make sure these
113 issues are specific enough (not &quot;how do I fix a build fault&quot;) they must
114 describe the following aspects thoroughly:</p>
115 <ul class="simple">
116 <li>The <em>title</em> describes the issue well enough for most users to quickly find
117 out if the topic is of interest for them or not. It is also displayed in
118 the search results</li>
119 <li>The <em>synopsis</em> gives more detail about the error, such as the full error
120 message, commands that triggered it or the (mis)behavior of a specific
121 command</li>
122 <li>The <em>environment</em> informs the user when the topic applies. If the users'
123 environment doesn't match this one, the topic isn't valid for him.</li>
124 <li>In the <em>analysis</em> section, the cause of the error is considered in great
125 detail to discover the essential flaw that triggered the error. It serves
126 as an information section for the user to comprehend what went wrong.</li>
127 <li>To fix the error, the <em>resolution</em> section guides the user through the
128 necessary steps to resolve the issue.</li>
129 </ul>
130 <p>A second type of queries would be small (but interesting) FAQs. These answers
131 are short and precise, most of the time one or two paragraphs.</p>
132 <p>Although several topics will be Gentoo specific, we will not limit ourselves
133 to this. However, we do not add topics that are specific to non-Gentoo
134 distributions.</p>
135 </div>
136 <div class="section" id="feedback-system">
137 <h2><a class="toc-backref" href="#id7" name="feedback-system">Feedback system</a></h2>
138 <p>The knowledge base should allow for user feedback. Feedback such as &quot;Does this
139 answer your question?&quot; is invaluable to improve the search results whereas
140 &quot;Mark this topic as outdated&quot; helps us keep the knowledge base in good shape.</p>
141 <p>We might want to consider allowing user comments too: they can add priceless
142 information to the topic, allowing the maintainer of the topic to update it
143 with more accurate information.</p>
144 </div>
145 <div class="section" id="topic-maintenance-system">
146 <h2><a class="toc-backref" href="#id8" name="topic-maintenance-system">Topic maintenance system</a></h2>
147 <p>Each topic should be maintained by a knowledgeable developer. The system must
148 allow the developer to watch his topics and update them when needed. Of
149 course, topics related to specific herds should be maintainable by the team
150 responsible for the herd.</p>
151 <p>Although not required, revision history would be great :-)</p>
152 </div>
153 <div class="section" id="license">
154 <h2><a class="toc-backref" href="#id9" name="license">License</a></h2>
155 <p>The content of the knowledge base should be public domain. Everything large
156 enough to warrant a different license shouldn't be in the knowledge base
157 anyway.</p>
158 </div>
159 </div>
160 <div class="section" id="frameworks">
161 <h1><a class="toc-backref" href="#id10" name="frameworks">Frameworks</a></h1>
162 <p>Based on the requirements, one or more frameworks will be chosen. These should
163 of course be free software projects; if we can't find any set of frameworks
164 that adheres to the requirements, the knowledge base project should build one
165 up until the requirements are met.</p>
166 <p>We currently do not have any technical requirements on the frameworks, but at
167 the end the knowledge base should be hosted on official Gentoo hardware and
168 maintained by the Infrastructure project. As such, the Infrastructure project
169 has final saying on the frameworks used in the knowledge base.</p>
170 </div>
171 <div class="section" id="copyright">
172 <h1><a class="toc-backref" href="#id11" name="copyright">Copyright</a></h1>
173 <p>This document has been placed in the public domain.</p>
174 </div>
176 </div>
177 <hr class="docutils footer" />
178 <div class="footer">
179 <a class="reference" href="glep-0051.txt">View document source</a>.
180 Generated on: 2006-08-16 19:24 UTC.
181 Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
182 </div>
183 </body>
184 </html>

  ViewVC Help
Powered by ViewVC 1.1.20