Rules

Secret ingredients to quality software

Do you write in the newsreader and eyewitness style?

Last updated by Tiago Ara├║jo [SSW] on 05 Apr 2021 10:43 pm (8 months ago) See History

General web content should always be written as if read by a newsreader. It is objective and describes its content professionally. A good example of this is Wikipedia.

I don't like JavaScript. I prefer jQuery because...

Figure: Bad Example - using 1st person writing makes it sound like opinion

jQuery is superior to JavaScript for this because...

Figure: Good Example - using 3rd person writing makes it sound like fact

When quoting a testimonial, you should use 1st person writing as if a newsreader had crossed over to an eyewitness for a personal view of the topic.

Don Bradman thought that SSW's work was fantastic!

Figure: Bad Example - impersonal

Don Bradman says: "I thought that SSW's work was fantastic!"

Figure: Good Example - 1st person in this context is appropriate

Adam CoganAdam Cogan
Ulysses MaclarenUlysses Maclaren

We open source. Powered by GitHub