RFC: TopicBasedHelp specification

Richard Johnson nixternal at ubuntu.com
Mon Nov 13 13:37:30 UTC 2006


On Sunday 12 November 2006 00:57, Matthew Paul Thomas wrote:
[snip]
> I don't see any conflict there. There are three basic kinds of topic:
> *   How do I do X?
> *   I have problem Y, how do I fix it?
> *   What is Z and how does it work?

How do we choose the questions that will get answered. This does sound 
strangely like an FAQ, and after reading about Topic-Based help, the main 
goal is to answer every questions, which extends it past the scope of an FAQ. 
How do we choose those questions? hopefully not the most frequently asked 
questions :)

[snip]
> And for the same reason you bought a printed book instead of reading
> online guides to SQL, in-depth manuals for Ubuntu should be targeted at
> the print medium instead of being crammed into the help viewer.

I am still 50/50 on this, but I do agree we shouldn't cram as much into the 
help viewer. For instance, you don't need the server guide and packaging 
guide crammed into Yelp/KHelpCenter. The desktop guide could go w/o being in 
the help viewers as well, however they should still be built the same way as 
always, and the Topic-Based Help should be something new. At least that's my 
opinion on it.

-- 
.:Richard Johnson
.:nixternal at ubuntu.com
.:ubuntu.com .:kubuntu.com .:edubuntu.com .:xubuntu.com
.:http://nixternal.ubuntu-rocks.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20061113/f28bd818/attachment.pgp>


More information about the ubuntu-doc mailing list