[Bug 994794] New: Suggestions for documentation improvement.

bugzilla at redhat.com bugzilla at redhat.com
Thu Aug 8 03:10:09 UTC 2013


https://bugzilla.redhat.com/show_bug.cgi?id=994794

            Bug ID: 994794
           Summary: Suggestions for documentation improvement.
           Product: Fedora Documentation
           Version: devel
         Component: install-guide
          Severity: low
          Assignee: pbokoc at redhat.com
          Reporter: lsatenstein at yahoo.com
        QA Contact: docs-qa at lists.fedoraproject.org
                CC: oglesbyzm at gmail.com, pbokoc at redhat.com



Improvement recommendation for Install Guide.

http://docs.fedoraproject.org/en-US/Fedora/19/html/Installation_Guide/Installation-Guide-Preface.html#idp16047392

Under 
1.1. Typographic Conventions

The indented paragraph reads
 To see the contents of the file my_next_bestselling_novel in your current
working directory, enter the cat my_next_bestselling_novel command at the shell
prompt and press Enter to execute the command. 

I would replace the word "see" with view. 

    To view the contents of the...

See for me, would be the result of issuing the ls command. See the file, view
the contents.

As an aside, for French translation,  "to see" translates to "regarder" 
whereas view tranlates to "voir". A similar difference is with Spanish

Please correct for Fedora 20.
======
Further on the same page...

Warnings should not be ignored. Ignoring warnings will most likely cause data
loss. 

My comment.

Warnings do not cause data loss. Warnings advise of a situation that if not
attended to, will most likely cause data loss. 

=======
Follow page with Introduction
Introduction
This guide covers installation of Fedora, a Linux distribution built on free
and open source software.

Please change ... built on ...  to built with. 

My reasoning... You may be on topic, or build on a foundation, but Fedora is
built with free and open source software

=======
Another question.  Would you say, "Install Fedora on a computer," or would you
say "Install Fedora onto a computer"?   

My preference is to drop the "on a computer".  That would shorten the sentence
and accommodate some future hardware device.

=======

2.1.1. How Do I Download Installation Files?
To follow a Web-based guide to downloading, visit
http://get.fedoraproject.org/. For guidance on which architecture to download,
refer to Section 2.1.2, “Which Architecture Is My Computer?”. 

Would the meaning be more clear if the title started with the word "Of" as in 
"Of which Architecture Is My Computer?"
(sections 2.1.2 and 2.1.3)

-- 
You are receiving this mail because:
You are the QA Contact for the bug.


More information about the docs-qa mailing list