Pages

Monday, January 24, 2011

Documentation for my class

It is important to develop the skill of effective communication, especially in written form. I have developed the following criteria for an effective blog post:
  • There should be some sort of introduction, a sentence or two, setting up what you are about to demonstrate. Included in this could be reasons why they need to know what you have to share and areas where the information would be helpful.
    Example: http://www.bennadel.com/blog/112-ColdFusion-Query-of-Queries-Uses-NULL-Values-Returns-Empty-Strings.htm
  • The code should be set apart from the rest of the text. This allows the reader to find the code they are looking for. You can use the following code formatter to accomplish this: http://codeformatter.blogspot.com/2009/06/about-code-formatter.html
  • The code should be cleanly formatted. This means that code inside of methods, tags, ifs, loops, etc should be indented. At times it's helpful to put a blank line between blocks of code to logically set them apart from other blocks.
  • If the code is more than a few lines, a break down of what each line means is also helpful for the reader.
  • Screen shots are a great way to demonstrate what you are trying to share. A picture is worth a thousand words.
  • Proper punctuation, spelling and sentence flow. In factoring your blog grade, I will be taking this into consideration. This means that you need to get into the habit of re-reading your post to see if it sounds right. Once you've done that, you need to re-re-read your post to check for additional readability and spelling problems.

No comments:

Post a Comment