Technical Review: preparing.xml

Dougie Richardson ddrichardson at btinternet.com
Tue Jul 8 16:17:40 UTC 2008


Hi,

Thanks for the review, but to save you duplicating any more effort - there
is already a student working on the switching from windows guide. I'll amend
the wiki page.

Cheers,

Dougie Richardson

> -----Original Message-----
> From: ubuntu-doc-bounces at lists.ubuntu.com [mailto:ubuntu-doc-
> bounces at lists.ubuntu.com] On Behalf Of Thomas Roten
> Sent: 08 July 2008 04:37
> To: ubuntu-doc at lists.ubuntu.com
> Subject: Technical Review: preparing.xml
> 
> This is my first Technical Review, so feel free to criticize any
> mistakes I've made.  I am eager to learn about the Documentation Team,
> so criticisms will help.
> 
> I reviewed all of the sections in the file titled "preparations.xml"
> under the "windows" category.
> 
> Here are the issues that I found with some of the sections:
> 
> Section:  preparing-settings-internet-dialup
>         Spelling of "user name" should be "username" according to
> https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/StandardTerminolog
> y
>         Spelling of "dialling" should be "dialing" according to the
> Style Guide (standard American English spelling only)
> 
> Section:  preparing-settings-internet-broadband
>         Spelling of "user name" should be "username" according to
> https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/StandardTerminolog
> y
>         Spelling of "dialling" should be "dialing" according to the
> Style Guide (standard American English spelling only)
>         Should be another comma before "or" in "DNS server, gateway IP
> address or DHCP server"
> 
> Section:  preparing-settings-network-home
>         Filename in step 4 is different from the one that it refers to
> in step 3
> 
> Section:  preparing-settings-network-windows
>         "There are several important pieces of information which you
> should have to hand if you would like to connect to a wireless
> network."  I assume this is supposed to be "have at hand".  But even
> so, shouldn't we refrain from idioms so that translating is easier?
> How about changing it to "There are several important pieces of
> information which you should have if you would like to connect to a
> wireless network."
> 
> Section:  preparing-settings-im
>         "User name" should be "username" according to
> https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/StandardTerminolog
> y
> 
> Section:  preparing-bookmarks-ie
>         The section is written for "Internet Explorer 6".  There should
> probably be an update to it as IE7 was released in 2006.
> 
> Section:  preparing-bookmarks-ie, preparing-bookmarks-firefox, and
> preparing-bookmarks-opera
>         "To backup your BROWSER NAME web browser:"  Are we backing up
> the web browser or the web browser bookmarks?  Should be changed to
> "web browser bookmarks:"
> 
> Section:  preparing-email
>         Typo:  "able to access it using the a web browser" should be
> changed to "using a web browser"
>         "from the Ubuntu Ubuntu community support website"  Is this the
> correct syntax?  Or should there just be one "Ubuntu"?
> 
> Section:  preparing-email-msoe
>         "from the Ubuntu Ubuntu community support website"  Is this the
> correct syntax?  Or should there just be one "Ubuntu"?
> 
> Section:  preparing-email-import
>         Is it necessary to specify "free, open-source"?  I don't think
> it contributes to the information that is supposed to be conveyed.
> 
> Section:  preparing-storage-cddvd
>         "labelled" and "labelling" should be "labeled" and "labeling"
> respectively according to the Style Guide (standard American English
> spelling only)
> 
> 
> Let me know if there is anything else I should do with these sections
> and corrections.
> 
> --
> Thomas Roten
> GPG Public Key:  http://www.tundrius.com/ThomasRoten.gpg





More information about the ubuntu-doc mailing list