Bug#280675: ITP: l2tpns
Jonathan McDowell <noodles@earth.li> schrieb:
> On Fri, Nov 12, 2004 at 12:17:20PM +0100, Frank Küster wrote:
>> Jonathan McDowell <noodles@earth.li> schrieb:
>> > Package: wnpp
>> > Severity: wishlist
>> >
>> > * Package name : l2tpns
>> > Version : 2.0.5
>> > Upstream Author : David Parrish and others <l2tpns-devel@lists.sourceforge.net>
>> > * URL : http://l2tpns.sf.net/
>> > * License : GPL
>> > Description : L2TP LNS which does not require l2tpd, pppd or any kernel patches.
>> >
>> > L2TPNS is half of a complete L2TP implementation. It supports only
>> > the LNS side of the connection.
>> [...]
>>
>> To my taste, this description contains too many abbreviations, and is
>> only understandable for someone who already knows what they mean. Please
>> follow the general guidelines for descriptions,
>>
>> file:///usr/share/doc/developers-reference/ch-best-pkging-practices.en.html#s-bpp-desc-basics
>
> This says:
>
> "The package description should be written for the average likely user"
>
> The average likely user should know what L2TP is and understand the
> LNSes role in this.
No, I don't think so. I think that "the average likely user" is meant to
be an average user of Debian, not the user of the package. This is
logical, because the purpose of the description is to allow a user to
decide whether he *is* the target user of the package.
Did you read the complete paragraph? It explains its intention with an
example:
,----
| Avoid referring to other applications or frameworks that the user
| might not be familiar with ? "GNOME" or "KDE" is fine, since users are
| probably familiar with these terms, but "GTK+" is probably not. Try
| not to assume any knowledge at all. If you must use technical terms,
| introduce them.
`----
If GTK+ is not acceptable, how can l2tpd, l2tp and lns be? They could,
if you _first_ state clearly that the package is only aimed at people
experienced in some type of network setup. Any user who wants to do
something about her dialup connection and enters "apt-cache search ppp"
should immediately know whether the package might be useful (perhaps
after some or a lot of reading) or whether it is about something
different.
> (And the only abbreviations I count in the description are L2TP [which
> gets expanded], LNS, PPP and ISP.)
That's about 3 to 4 too much. Generally, because of good style,
not because they are unfamiliar to me.
Regards, Frank
--
Frank Küster
Inst. f. Biochemie der Univ. Zürich
Debian Developer
Reply to: