[Testing] I would like feedback on the "How_to_use_the_IRC_Application" wiki page

James Cameron quozl at laptop.org
Tue Dec 13 17:20:29 EST 2011

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.  ;-)

James Cameron

More information about the Testing mailing list