Thursday, October 7, 2010

Basic Template with Ingredients for a Technical Blog

A good Technical Blog Post follows the Law Of Retention: repetition helps Retention

Some Questions on your Blog Post:
  • Is your blog a frequently used resource for yourself and your readers? 
  • Does it grow as you learn more - addressing different levels of questions?
  • Is it short and informative while being complete and self-contained? 
Is your blog addressing The Readers Perspective?
  1. What's in it for a Reader?
  2. Tell 'em what you're going to Tell 'em.
  3. Tell 'em.
  4. Tell 'em what you just told 'em.
  5. Further info.

Sample Blog Format: The final post may contain the following info in order of importance:
Why:
  1. Rationale: How it will help the reader by reading this topic.
  2. Summary: What this blog post talks about.
  3. Audience: Type of people this post is meant for (general, students, professionals, admin, programmer)
What:
  1. Screen-shots/diagrams/Photos/Videos which display the things in a tangible way.
  2. Describe the basic "things" that are involved in the topic
  3. Describe the useful/important inter-relations between the things
How:
  1. howto configure these relations to get the necessary output
  2. FAQs on common problems and solutions
  3. How things work together (collected from various sources - blogs, forums, articles, books on the topic)
  4. Source code snippets illustrating your ideas.
Reference Links: (Braindump of your browsing sessions.)
  1. Introductions: Download sites, Tutorials, Blogs.
  2. Detailed Info: Forum posts, Settings/Configuration notes, faqs, Howtos
  3. References: Guides, Reference books with more in breadth and depth on different aspects of the topic.
See Also: Apprenticeship Patterns "Record-What-You-Learn" and "Share-What-You-Learn"

No comments:

Post a Comment

Note: Only a member of this blog may post a comment.