Tips for Writing Tutorials

by Randall 6/5/2008 12:38:00 PM

I'm finally digging into Windows Workflow Foundation so I decided to try some tutorials. (Yes, I am fully aware that it's been out there for over a year and a half now.)

I know that CodeProject has a good reputation and occassionally I have found good resources there.  However, for the most part, the tutorials that are placed there are utter garbage.  Instead of hurrying to get something out there so you can say you've been 'published', take some time and follow these suggestions. 

  • DO use correct grammar and spelling.  If you are not a native English speaker, then find someone who is to proof your submittal.
  • DON'T tell the reader to 'copy & paste' your code.  Do explain to them WHY you are doing it.
  • DO be sure and point out any references that you're using so the reader can be sure to use the proper 'Includes {namespace]}'.  The reader is trying to learn something; you're trying to help them - so help them.
I'm certainly not an expert on tutorial writing - just a consumer of them.

Be the first to rate this post

  • Currently 0/5 Stars.
  • 1
  • 2
  • 3
  • 4
  • 5

Tags: , , ,

Powered by BlogEngine.NET 1.3.1.0
Theme by Mads Kristensen

About the author

Name of author Randall Sexton
Currently a .Net developer for Bechtel Corporation in Oak Ridge, TN.

E-mail me Send mail

Calendar

<<  April 2014  >>
MoTuWeThFrSaSu
31123456
78910111213
14151617181920
21222324252627
2829301234
567891011

View posts in large calendar

Pages

    Recent comments

    Don't show

    Authors

    Categories


    Logo Credit

    My logo was taken from CodingHorror.
    Jeff Atwood © Copyright 2007

    Disclaimer

    The opinions expressed herein are my own personal opinions and do not represent my employer's view in anyway.

    © Copyright 2014

    Sign in