[IAEP] [Testing] I would like feedback on the ''How_to_use_the_IRC_Application'' wiki page
forster at ozonline.com.au
forster at ozonline.com.au
Tue Dec 13 18:51:48 EST 2011
Tom
Yes the smaller screenshots are better as per James' suggestion.
It is good if you can show the tooltip and manually add a cursor which shows the next step. I have edited the first screenshot to show what I mean. (You might want to redo it though to get consistent colours and size)
I have also edited 'F3' to 'Home (or F3)' as per James' suggestion
Tony
> Thank you for your comments;
>
> I have tried to do some of what you requested:
> http://wiki.sugarlabs.org/go/Sugar_Creation_Kit/sck/How_to_use_IRC
>
> I reduced the size of the screen-shots[1] and tried to bullet all user
> actions in a more consistent way.
>
> [1] Editing is easy:
> [[File:Screenshot_of_IRC_Join_cmd2.png|600px]]
> the |xxxpx can be adjusted easily for the best size.
>
> Please do edit this wiki page, I value all additions and points of view.
>
> This page was composed last night, after a request for such a guide on
> #sugar IRC
>
> Cordially
>
> Tom Gilliard
> satellit_ on #sugar
>
> (I was trained as a geological oceanographer, so my writing style may
> reflect this.)
>
> On 12/13/2011 02:20 PM, James Cameron wrote:
> > On Tue, Dec 13, 2011 at 07:41:07AM -0800, Thomas C Gilliard wrote:
> >> I just wrote this wiki page:
> >> http://wiki.sugarlabs.org/go/Sugar_Creation_Kit#How_to_use_the_IRC_Application
> >> (Annotated screen shots that show you how to use the IRC application)
> >>
> >> My question:
> >> Is this a useful way to build guides for beginners?
> > No, because the way leads to a guide that is very hard to read.
> >
> > The text styles keep changing. Use of indentation is inconsistent. The
> > images are too large and break up the flow of the text. Some bolding is
> > used spuriously. The difference between user actions and software
> > actions is not clear. Terms are inconsistent with Sugar design (e.g. f3
> > screen). No mention of needing an internet connection first.
> >
> > These things would conspire to make it very hard for a beginner to read
> > the page.
> >
> > You might like to read an english style guide. Also try to think in
> > terms your reader will understand, and each time you use a word,
> > consider whether it is the right word to use.
> >
> >> I think as "it is a wiki" these provide a way for users to
> >> participate in updating in these guides.
> >>
> >> I would like feedback on this project.
> > Good idea. I won't edit it though, because I don't know you'd agree
> > with the changes I make. ;-)
> >
> _______________________________________________
> IAEP -- It's An Education Project (not a laptop project!)
> IAEP at lists.sugarlabs.org
> http://lists.sugarlabs.org/listinfo/iaep
>
> _____________________________________________________
> This mail has been virus scanned by Australia On Line
> see http://www.australiaonline.net.au/mailscanning
More information about the IAEP
mailing list