GNU bug report logs - #61325
30.0.50; Jokes in GNUS manual

Previous Next

Full log

View this message in rfc822 format

From: Ihor Radchenko <yantar92 <at> posteo.net>
To: Pankaj Jangid <pankaj <at> codeisgreat.org>
Cc: 61325 <at> debbugs.gnu.org
Subject: bug#61325: 30.0.50; Jokes in GNUS manual
Date: Tue, 07 Feb 2023 19:56:12 +0000

Pankaj Jangid <pankaj <at> codeisgreat.org> writes:

>> The paragraph structure is basically:
>>
>>  <technical description><joke><half joke, half technical description>
>>
>> Such structure is difficult to understand, especially if the joke itself
>> is not understood.
>
> But you have understood the above structure. Then what is the issue?

The issue is that it took an extra effort to understand it. Not because
of technical details, but simply because of presence of jokes.

IMHO, the primary aim of manuals is explaining technical information to
the users. Jokes that help to understand or at least does not hurt are
totally fine. But when jokes makes the information harder to understand,
isn't it against the aim of writing a good manual?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.