What to do about grammatical errors in tutorials

[splinky]

A question about the proper way to do things...

My basic question is a multiple choice one, so I'll get it out of the way up front. The question is, if I notice a grammar or spelling error in a tutorial, should I

(A) Post the error as a comment to the tutorial
(B) Post the error somewhere else, and if so, where
(C) Just ignore it and only report technical errors

My personal feeling is that grammar and spelling errors in tutorials should be reported and fixed, since the tutorials are a major attraction for the site and we want them to look professional. But, does it make sense to post such corrections as comments to the tutorials, where they'll presumably hang around even after the error has been fixed?

Of course, I may well be in the minority in thinking that grammar and spelling errors need to be mentioned at all. Earlier this evening, I posted Comments for, which mentioned a grammatical error in the "Basics" tutorial. Almost immediately, I got dinged twice for sounding like an English teacher. Since then, a couple of people must have ++'d it, because that item's rep now stands at 0, so I'm getting mixed messages here.

I'm so confused! Help!!

*Woof*

[Maclir]

I agree with Splinky here. Spelling and grammar are important, particularly so in a permanent document like a tutorial. I believe the tutorials should be "stand alone" documents, without the need for a trail of comments and corrections to make sense of them. The author of the tutorial should make the corrections within the actual tutorial itself.

This means some method of notifying a tutorial author of any errors (technical or gramattical) is needed.

Ken

[gaggio]

I don't know how hard it would be to add some kind of spell checker to parse a submission each time there is a new article, but it might be interesting: the basic framework is already there, since it is possible to edit and re-edit your article to make it "look good", usually by changing the HTML tags.

So... If there is such a parser, I think it should not be too hard to show the words that might have errors by painting them in red (I am thinking that this should be something that only the author should be able to see, so maybe that it should be a new tag like <GRAM></GRAM>.

Well, this is just an idea. I do think that grammar is important but it does not make things "unreadable". It just makes it look more perfect, which is something to consider because Monks are seeking/showing the "Truth" in their contributions.

[BBQ]

I guess there is no established method of reporting these sorts of technical glitches, but if I noticed something wrong, I'd probably post to Editor Requests and /msg the author in the chatterbox if I found it appropriate. I don't think there's a need to warn the author for his/her spelling mistakes... God knows that if everyone were to /msg me whenever I screwed up my spelling or grammar I'd be in a world flooded by /msgs. :)

#!/home/bbq/bin/perl
# Trust no1!

[gryng]

I agree with the solution of a /msg to the Author, because this would seem to get the job done, and also cost the least.

As for my opinion on the importance of spelling in grammar -- If you notice the error, then it's probably serious enough that you should /msg the author. Spelling and grammar rules are like computer protocols. The rules of both are there to help aid effective communication.

This is especially true for people that do not know the language as well as others -- if you notice the error, chances are others with less understanding might misinterpet the meaning of the sentence, or have trouble understanding your unique "gift" at spelling a certain word.

I know that I am not the best speller, nor am I am terribly proficient at grammar. But I try to make a point of correcting my words that I give to others so that they will better understand my views. (It also makes me sound smarter! :P :) ).

Well that's it for me,
Gryn

[redmist]

I don't think that tutorials need (within reason) to be grammatically correct. If this was a soley commercial site, and only vroom and other designated people wrote up tutorials, it would be a different issue. Even then, grammatical erors don't effect the quality of the information found on PM.

redmist

[toadi]

well,

I disagree. My english is not perfect beacuse it isn't my native language.
I learn the language on the net and from reading o'reilly books:-)

I understand it an can read it, but I make many grammatical errors. So by reading(maybe even for a native english speaking guy) tutorials you pick up(sometimes without even thinking about it syntax and grammar.

What is more fun, learning to write and talk better english by doing things you usaully do or by learning it in school?
I made my choice!
--
My opinions may have changed,
but not the fact that I am right

[mrmick]

Although using 'correct' grammar is an important part of writing, I don't think that anyone here - especially me - claims to be an English expert.
After all, if that were the case, we would be tearing apart the 'American' spelling of English words such as COLOR (correct spelling: COLOUR). Admittedly, this is a pet peeve of mine but since all programming languages and most documentation I've seen have used these, I just sit back and use what's there while I quietly grind my teeth.
Now to the point:
• As long as the document can be easily understood without a lot of ambiguity, we should leave any grammatical errors as they are.
• Be thankful,or at least appreciative, that there is a tutorial around to help those who need it.
• If there is a serious problem with the grammar, simply /msg the author and explain your concern.
This is just my opinion but I think that we can be much more productive and helpful to one another by letting a few little grammatical errors slide.