General Guidelines on how to write a good tutorial / create a good snippet.
Snippets- Choose a snippet that answers a specific question (preferable unanswered)
- Rename the variables to make their context clearer.
- Add comments to your snippets
- Test your code! Does the snippet really work.
- State the frameworks it needs.
- Example usage. In code comments is ok.
- Example results. In code comments is ok.
Tutorials- Choose a area/topic which is of interest, people are struggling with.
- Rename the variables to make their context clearer.
- Add comments to your code snippets
- Explain the reason / your rational for doing it this way
- Use different colours to make explanation clearer, if it would help.
- Use pictures and diagrams.
- Anticipate possible problems. Post the problem. Explain the cause/s. Offer a solution/s.
- If possible attach a working copy of the code with source code. (Zipped of cause, No Naked exes here.)
- Check your spellings. (No Text Speak)
- Check your grammar. Does what you have written make sense.
- Use your Author & Contributors Topic to write drafts.
- Don't be scared of using the Preview Post button. It won't bite, plus it lets you examine the post.
- Don't submit till you sure it ready, or wait a few days and reread / redo your draft.
Tutorial Pictures/Attachments- Reattach and reinsert them into your submitted tutorial.
I didn't. I just did a straight Copy & Paste of the draft. No Pictures. Confused the hell out of me.
This post has been edited by AdamSpeight2008: 20 Oct, 2009 - 06:52 PM
Forum Index:
Programming Help |
C and C++ |
VB6 |
Java |
VB.NET |
C# |
ASP.NET |
PHP |
ColdFusion |
Perl and Python |
Ruby |
Databases |
Other Languages |
Game Programming |
Mobile Development |
Software Development |
Computer Science |
Industry News |
Programming Tutorials |
C++ Tutorials |
Visual Basic Tutorials |
Java Tutorials |
VB.NET Tutorials |
C# Tutorials |
Linux Tutorials |
PHP Tutorials |
ColdFusion Tutorials |
Windows Tutorials |
HTML/JavaScript Tutorials |
CSS Tutorials |
Flash Tutorials |
Web Promotion Tutorials |
Graphic Design & Photoshop Tutorials |
Software Development Tutorials |
Database Tutorials |
Other Language Tutorials |
ASP.NET Tutorials |
Game Programming Tutorials |
WPF & Silverlight Tutorials |
| 
