improving online documentation
mdke at ubuntu.com
Mon Apr 30 09:17:48 UTC 2007
On Mon, April 30, 2007 10:04 am, Ari Torhamo wrote:
> ma, 2007-04-30 kello 07:47 +0100, Matthew East kirjoitti:
>> > Would it
>> > be possible to stop PageTitlesLookingLikeThis too?
>> It's certainly possible, although personally I don't think it's a
>> significant issue.
> I think this thing is very different in the eyes ordinary people and
> people who are used to write HTML, XML and who perhaps code, etc. In the
> eyes of ordinary people there's something contradicting in the sentence
> "UbuntuIsEasyToUse". People don't meet this kind of writing style
> elsewere (except in some funny writings). Not many of us would like to
> see menu items in the desktop panel written like "SearchForFiles",
> "RecentDocuments", "RestrictedDriversManager", etc. Why write like this
> in the documentation (if it can be avoided)?
We need to distinguish here between two things. The first is using
PhrasesLikeThese in the body of documentation, which is what you're
describing, and which, you're right, is clearly confusing and difficult to
read. We should encourage people to use easy to read link text (which is
perfectly possible in MoinMoin).
What Phil mentioned in his original post, and what I was saying is not a
significant issue, is the actual URL of the page looking odd. This is only
problematic (in my opinion) where the PhraseLikeThis carries over to the
actual page title (which is fixed in recent Moin versions which add spaces
between the words). I don't think the actual URL is a big deal.
gnupg pub 1024D/0E6B06FF
More information about the ubuntu-doc