"TL;DR:"

Started by Kevin Grittneralmost 14 years ago6 messagesdocs
Jump to latest
#1Kevin Grittner
Kevin.Grittner@wicourts.gov

[I had a bit of trouble picking which list to use; I guess Wiki
pages are part of our docs, in a way...]

How do people feel about "TL;DR:" being used at the start of a Wiki
page to which we want to direct users?

http://wiki.postgresql.org/wiki/Guide_to_reporting_problems

I'll go first -- I hate it.

Every time I bring up the page before referring a user there, I find
that those geeky capital letters in bold screaming at me are
distracting and annoying. Since Craig obviously doesn't, I didn't
want to just change it without other input.

Personally, I think "keep reading" in bold probably covers it.

-Kevin

#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Kevin Grittner (#1)
Re: "TL;DR:"

"Kevin Grittner" <Kevin.Grittner@wicourts.gov> writes:

How do people feel about "TL;DR:" being used at the start of a Wiki
page to which we want to direct users?

http://wiki.postgresql.org/wiki/Guide_to_reporting_problems

I'll go first -- I hate it.

I think it's a pretty lousy way to start off this page in particular;
way too flippant for something we point newcomers to when they ask
for help. +1 for rewriting in a more formal style.

regards, tom lane

#3Greg Sabino Mullane
greg@turnstep.com
In reply to: Kevin Grittner (#1)
Re: "TL;DR:"

-----BEGIN PGP SIGNED MESSAGE-----
Hash: RIPEMD160

How do people feel about "TL;DR:" being used at the start of a Wiki
page to which we want to direct users?

Very inappropriate there: remove 'em!

- --
Greg Sabino Mullane greg@turnstep.com
PGP Key: 0x14964AC8 201204251316
http://biglumber.com/x/web?pk=2529DF6AB8F79407E94445B4BC9B906714964AC8
-----BEGIN PGP SIGNATURE-----

iEYEAREDAAYFAk+YMZ8ACgkQvJuQZxSWSsiOIQCg64VLuuwpqXhL8x5Vi2zmStYp
SrIAoO2zb9lXKuPOhDRYRbQCB4Wvmfnv
=8nCh
-----END PGP SIGNATURE-----

#4Kevin Grittner
Kevin.Grittner@wicourts.gov
In reply to: Greg Sabino Mullane (#3)
Re: "TL;DR:"

"Kevin Grittner" <Kevin.Grittner@wicourts.gov> writes:

How do people feel about "TL;DR:" being used at the start of a
Wiki page to which we want to direct users?

Tom Lane <tgl@sss.pgh.pa.us> wrote:

I think it's a pretty lousy way to start off this page in
particular; way too flippant for something we point newcomers to
when they ask for help. +1 for rewriting in a more formal style.

"Greg Sabino Mullane" <greg@turnstep.com> wrote:

Very inappropriate there: remove 'em!

I took a shot at reworking the portion ahead of the TOC, but I know
there are better wordsmiths than I out there. If anyone wants to
redo it, I won't be offended.

I have a feeling the "Why were you sent this link?" section is a
little harsh, too; but haven't taken a run at that yet.

-Kevin

#5Selena Deckelmann
selenamarie@gmail.com
In reply to: Kevin Grittner (#4)
Re: "TL;DR:"

On Wed, Apr 25, 2012 at 10:35 AM, Kevin Grittner <
Kevin.Grittner@wicourts.gov> wrote:

"Kevin Grittner" <Kevin.Grittner@wicourts.gov> writes:

How do people feel about "TL;DR:" being used at the start of a
Wiki page to which we want to direct users?

Tom Lane <tgl@sss.pgh.pa.us> wrote:

I think it's a pretty lousy way to start off this page in
particular; way too flippant for something we point newcomers to
when they ask for help. +1 for rewriting in a more formal style.

"Greg Sabino Mullane" <greg@turnstep.com> wrote:

Very inappropriate there: remove 'em!

I took a shot at reworking the portion ahead of the TOC, but I know
there are better wordsmiths than I out there. If anyone wants to
redo it, I won't be offended.

I have a feeling the "Why were you sent this link?" section is a
little harsh, too; but haven't taken a run at that yet.

Reworded it. Now looking at the rest of the document.

-selena

--
http://chesnok.com

#6Selena Deckelmann
selenamarie@gmail.com
In reply to: Selena Deckelmann (#5)
Re: "TL;DR:"

On Thu, Apr 26, 2012 at 5:22 PM, Selena Deckelmann <selena@chesnok.com>wrote:

On Wed, Apr 25, 2012 at 10:35 AM, Kevin Grittner <
Kevin.Grittner@wicourts.gov> wrote:

"Kevin Grittner" <Kevin.Grittner@wicourts.gov> writes:

How do people feel about "TL;DR:" being used at the start of a
Wiki page to which we want to direct users?

Tom Lane <tgl@sss.pgh.pa.us> wrote:

I think it's a pretty lousy way to start off this page in
particular; way too flippant for something we point newcomers to
when they ask for help. +1 for rewriting in a more formal style.

"Greg Sabino Mullane" <greg@turnstep.com> wrote:

Very inappropriate there: remove 'em!

I took a shot at reworking the portion ahead of the TOC, but I know
there are better wordsmiths than I out there. If anyone wants to
redo it, I won't be offended.

I have a feeling the "Why were you sent this link?" section is a
little harsh, too; but haven't taken a run at that yet.

Reworded it. Now looking at the rest of the document.

Ok, I made some changes. The numbering really stymied me.

Greg -- is there a better way to manage the numbering? One of the problems
with the long lists is that they are not numbered - so if you're a poor bug
reporter trying to scan that list, you lose your place. But I want the
formatting to be consistent without having to give numbers to the
sub-points.

-selena

--
http://chesnok.com