Revised wording for Feedback section

[Ruediger Landmann]

  Hi all:

The start of each of our manuals contains a "Feedback" section that 
tells readers how to report bugs against the document. Last week, Sparks 
and I started wondering if the wording could be improved a little.

========
Present wording:

"We Need Feedback!

If you find a typographical error in this manual, or if you have thought 
of a way to make this manual better, we would love to hear from you! 
Please submit a report in Bugzilla: http://bugzilla.redhat.com/bugzilla/ 
against the product Fedora Documentation.

When submitting a bug report, be sure to mention the manual's 
identifier: install-guide

If you have a suggestion for improving the documentation, try to be as 
specific as possible when describing it. If you have found an error, 
please include the section number and some of the surrounding text so we 
can find it easily. "

========
My suggestion:

"We Need Feedback!

If you find an error in this manual, or if you think of a way to make 
this manual better, we would love to hear from you!

To report an error or make a suggestion:

1. Visit Red Hat Bugzilla to enter a bug for Fedora Documentation: 
https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora%20Documentation

2. Sign in with your Red Hat Bugzilla account, or create an account if 
you do not already have one.

3. Select this manual (install-guide) from the list of Components.

4. Write a short summary of the error or suggestion in the Summary field.

5. Describe the error or suggestion in more detail in the Description 
field. If you have a suggestion to improve the documentation, be as 
specific as possible. If you have found an error, please include the 
section number and some of the surrounding text so we can find it easily.

6. Click the Submit Bug button."

========

Other ideas or refinements welcome! What do you think?

Cheers
Rudi

[Eric Christensen]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 10/10/2010 09:33 PM, Ruediger Landmann wrote:
>  My suggestion:
>  
>  "We Need Feedback!
>  
>  If you find an error in this manual, or if you think of a way to make 
>  this manual better, we would love to hear from you!
>  
>  To report an error or make a suggestion:
>  
>  1. Visit Red Hat Bugzilla to enter a bug for Fedora Documentation: 
>  https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora%20Documentation
>  
>  2. Sign in with your Red Hat Bugzilla account, or create an account if 
>  you do not already have one. 
I wonder if there is a wiki page that would help a newbie out in this
area or if the existing help on the BZ page would be sufficient or if
any help is needed/desired.

>  
>  3. Select this manual (install-guide) from the list of Components. 
Assuming this comes from the .ent file.
>  
>  4. Write a short summary of the error or suggestion in the Summary field.
>  
>  5. Describe the error or suggestion in more detail in the Description 
>  field. If you have a suggestion to improve the documentation, be as 
>  specific as possible. If you have found an error, please include the 
>  section number and some of the surrounding text so we can find it easily.
>  
>  6. Click the Submit Bug button."
>  
>  ========
>  
>  Other ideas or refinements welcome! What do you think? 
I think this is a great improvement.  I'm assuming we will be using this
for F15 and not F14 being that we are so late in the game for
translations to occur.

>  
>  Cheers
>  Rudi 
Thanks Rudi!

- --Eric
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.10 (GNU/Linux)
> Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/
>
> iQIcBAEBAgAGBQJMs6jXAAoJEDbiLlqcYamxzlUQAJNfiUIwXB/tjqYfAAvW/Raw
> uH7mkz5RAQUguv1WziBa5DFKZcFnJMRZxEKMKD7OK7FERDvS4Hxwp5iUxfuTctq8
> yWoEkvIs4o5o05DFVJnfsshx3MbbxtlGLSASWxYpo0IbDSRx9z+Qfo8xPhUaKRVx
> h0iRPBtUKr+rA9pmPfOGudkMh3JIE+/fZllO88KHwyq3xKFQLFffKE5VwxU+aGEn
> yzrsYQF5uHT5iPwL9LwxyFjRSn5vFw3z32+hXzR3EYc5M9aym05Hj7BqUM4BWKuo
> v+z4GNovct5t8O7QsWOp2UW24FsUdX4rIQOkZWkcOiM5kyUApXcb8ag+TCb0STFp
> phaNOcP+C1DRsiFYYhAl7NbwVUZp3UWkM9mJCjxp44t/rpx7TrWeX5OXpNtfL9Ob
> Oe1DdcUqpySHzXswkTT+EBTuJE+nfQsba7p0gauM4EHA3CZ4pR7RfRmX3aFo5qm1
> CS1r+hAAoaAnwfJZeCyoQAGp0BDDOfbgBTBs+HZ1gejLd69z3PiK5lmYkRRkcKvQ
> Szw6Yl03fzdj8u8B45RQS7DFMNSuMKlwbZGeBLAri5lfJxGoa2snC9himoOSa0YN
> QuX3niKaciOAQsSUYYYckFcuYenupvjq8xaTaQn4b2mfslJxkHMkLVVYwxGxt3YX
> S1XxzMFKrV5ikQ3OVer+
> =rSzi
> -----END PGP SIGNATURE-----

[Ruediger Landmann]

  On 10/12/2010 10:16 AM, Eric "Sparks" Christensen wrote:
>  On 10/10/2010 09:33 PM, Ruediger Landmann wrote:
> > 2. Sign in with your Red Hat Bugzilla account, or create an account if
> > you do not already have one.
>  I wonder if there is a wiki page that would help a newbie out in this
>  area or if the existing help on the BZ page would be sufficient or if
>  any help is needed/desired. 
I wrestled with that too and took a look at the Bugzilla instructions. 
To me, signing up there didn't look any harder than signing up for the 
kinds of things for which most people sign up routinely on the Internet 
these days (social networking sites, forums, posting comments to 
newspapers or YouTube). What do others think? Does anyone here remember 
having trouble signing up for Bugzilla for the first time?

> > 3. Select this manual (install-guide) from the list of
> Components.
>  Assuming this comes from the .ent file. 
Yeah, the Component name comes from &BOOK-ID; in the .ent file of the book.

Similarly, "Fedora Documentation" in step 1 comes from &PRODUCT;. Now 
that I think of it, that URL should probably also go in an entity; if 
any book needs a different Product, it will need a different URL as 
well, if we're going to pre-load the product (which saves a couple more 
steps of navigation).


>  I think this is a great improvement.  I'm assuming we will be
> using this
>  for F15 and not F14 being that we are so late in the game for
>  translations to occur. 
Yeah, too late for F14 as I had originally hoped.

I guess one other question is whether we want to add a "Getting Help" 
section like we have in Red Hat docs? For example, "Do You Need Help?" 
-- http://tinyurl.com/2ddtzdh

Cheers
Rudi

[Eric Christensen]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 10/11/2010 08:45 PM, Ruediger Landmann wrote:
>   On 10/12/2010 10:16 AM, Eric "Sparks" Christensen wrote:
> > On 10/10/2010 09:33 PM, Ruediger Landmann wrote:
> >> 2. Sign in with your Red Hat Bugzilla account, or create an account if
> >> you do not already have one.
> > I wonder if there is a wiki page that would help a newbie out in this
> > area or if the existing help on the BZ page would be sufficient or if
> > any help is needed/desired.
>  
>  I wrestled with that too and took a look at the Bugzilla instructions.
>  To me, signing up there didn't look any harder than signing up for the
>  kinds of things for which most people sign up routinely on the Internet
>  these days (social networking sites, forums, posting comments to
>  newspapers or YouTube). What do others think? Does anyone here remember
>  having trouble signing up for Bugzilla for the first time? 
Perhaps this is not necessary.  If we determine, later, that this is a
need it would probably be an extremely small change; one that could be
easily implemented later.

>  I guess one other question is whether we want to add a "Getting
> Help"
>  section like we have in Red Hat docs? For example, "Do You Need Help?"
>  -- http://tinyurl.com/2ddtzdh 
I like this.  We don't have a knowledge base but we do have a wiki and
we have lists!

>  
>  Cheers
>  Rudi
>   
- --Eric
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.10 (GNU/Linux)
> Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/
>
> iQIcBAEBAgAGBQJMs700AAoJEDbiLlqcYamxQBsQAK+XthifLbJpafbwF6bRiD4N
> 0earPXS4mG8sMr/XTp/9ZII6uZICBiS5Ubx2fNrO9uBFZJLjozkE1WcKu7vS/aWN
> m8kVsNU9hr63AVPUOTtZVrajzod1W7GqEHbydgUg9RhI1IKmnjst5cYTuf9Af2ia
> /Y+IR4gC2ZAF9ugUlYNfBCl5Wvgy0drkvu/+MlYOblFUtrr9s2fdoQns81Qo/ybH
> a6/VLGOQ/0xfcbxYWbQKsC8w4OMlG57GeIcaBFMDx9uxI6JFEbHQ2XmrdbSIT+bR
> a84PpfpLhfJP8lf6A62W0LuKGjuerl9T3tzE2WpnQq6jY4JL5XpLYcvEcngrgGcs
> 6/Tw7IKGZ+ByqdeC5oA2MWQ5CHNboZws5f4IQGnK2RxB311vKy5pQtVz0USbRhUm
> Dw3GQp8lY0DCTvH/FxMXVeiKXfT+uxnPAIF35CQvmctRuXLuLxDlTutLegAv7vOX
> SLhD3uUsogvWfpW1NJc9fE7MVsE9iI3xuVrqbgLU8OFZqYjmM3TTZk8WvxJcLBE6
> VreumcsyvtHDLP+5PkvQvzqXmVtbylH16i8sJDsAFtZiMwR41Sf+A+LoUV3Nq7uz
> KTDC+z4KOsM9XYarJizm2vyJMPKzWOP6suDqGSsafYZ1ao/iRo9qVkOxP+8N1AQn
> Ut4G6E5mj6Ty8jdzsDEW
> =utnu
> -----END PGP SIGNATURE-----