Standard for Tutorial & Snippet

Discuss.

Page 1 of 1

1 Replies - 563 Views - Last Post: 17 September 2010 - 09:16 AM

#1 AdamSpeight2008   User is offline

  • MrCupOfT
  • member icon

Reputation: 2298
  • View blog
  • Posts: 9,535
  • Joined: 29-May 08

Standard for Tutorial & Snippet

Posted 17 September 2010 - 08:46 AM

Lets begin by showing the existing guidelines.

Snippet Guidelines:

Quote

A Code Snippet is a useful piece of code which accomplishes a common task, demonstrates a technique or concept, fills a gap in an existing language, and could be reused in an existing application. Snippets should be well commented and explain the concepts being used. Snippets should be useful to a wide audience. Snippets should conform to standards when possible.

Snippets should not simply be an example of a built in function or library. Snippets should not be full applications unless the application demonstrates a useful concept. Snippets should not be malicious or violate any laws (including intellectual property laws).

A Code Snippet is a useful piece of code which accomplishes a common task, demonstrates a technique or concept, fills a gap in an existing language, and could be reused in an existing application. Snippets should not simply be an example of a built in function or library.


A few initial questions to open the discussion.

What do think the maximum length should be?
Should complete programs also be classed as snippets?
What should be the minimum quality standard?


Tutorial Guidelines.

Quote

A tutorial is a detailed explanation and instruction of a concept or technique. Tutorials are usually based on complete applications and explain each step involved in creating the application or implementing the concept. Tutorials should introduce the idea being discussed, and explain step by step how to complete task. Tutorials should include screen shots, code, and any other supporting documentation or references.


Should there also be a zipped copy of the code attached?
What should be the minimum quality standard for a tutorial?


Mod Advicement: Just because this is a discussion about the quality and standard for snippets and tutorial, doesn't give you free rains to slag off particular ones.

Is This A Good Question/Topic? 0
  • +

Replies To: Standard for Tutorial & Snippet

#2 macosxnerd101   User is offline

  • Games, Graphs, and Auctions
  • member icon




Reputation: 12800
  • View blog
  • Posts: 45,992
  • Joined: 27-December 08

Re: Standard for Tutorial & Snippet

Posted 17 September 2010 - 09:16 AM

For snippets, length isn't really relevant to me. You'll get some really long and in-depth snippets, and you'll get some smaller snippets. As long as they work and explain the concepts (including what output to expect and input is to be provided), it does not matter to me.

For tutorials, they should thoroughly cover the concepts and leave the reader coming away having learned more than when they looked at the tutorial. So for example, saying "here are the HTML tags, this is the order they go in" is not a valid HTML tutorial. Explain each tag. Provide the uses. Why are they used? Are they deprecated? Are there better ways with CSS? Even if you don't go into the nitty-gritty CSS and defer that to another tutorial, you hit on that point.

As for the ZIP attachment, I would leave that at the discretion of the author.

Just my $.02. :)
Was This Post Helpful? 0
  • +
  • -

Page 1 of 1