PrestwoodBoards.com
-Collapse +Expand

Tech Writer

Search Tech Writer Group:

Advanced
-Collapse +Expand Tech Writer Group Home
-Collapse +Expand Message Board
-Collapse +Expand Knowledge Base
-Collapse +Expand Tech Writer Store
-Collapse +Expand Members Only
Prestwood Tip Jar
Tip Jar
Finding something useful?

Add to the
Tip Jar!

Prestwood eMagazine

Subscribe now!
Enter your email:


   PrestwoodBoardsMessage BoardsTechnical Writing BoardTech Writing Topic   

Couple New Articles

Prestwood: Couple New Articles in Tech Writing topic (part of our Technical Writing group).

Tags: Articles   Couple New   Couple New Articles  
Next Random Thread || Change Group Random From All
Jump to Latest -Collapse New Thread
Prestwood IT Solutions
Staff
Moderator
Mike Prestwood
Rank: Fleet Admiral

Joined: Oct 2000
Location: Citrus Heights, CA USA
Mike Prestwood -Collapse +Expand
Email Approved! E CA USA
Thread Starter... 1/29/2009

We've posted a couple new articles to the tech writing group...

Prestwood Online Style Guide

Use up to four levels within articles (Heading 1..4). Within text, bold language elements and menu options. Use italics to bring attention to non-code things such as companies, important words, etc. Use bold+Italic for embedded topics and follow with a colon. Use the paragraph style for text and preformatted for code. Max width for images is 700 pixels.

 

Guidelines for Good Sample Code

Sample code often provides the quickest, clearest way to learn how an SDK works. If you have software engineering experience, then you should already know many principles for writing good code. However, what you may not realize is that some of the good practices that you learned for writing good production code do not apply to writing good sample code. Some techniques, such as comments and clear variable names, apply to both production code and sample code. However, there are good reasons to use hard-coded values in sample code, which should be avoided in production code, and there are good reasons to avoid object-oriented designs when writing sample code.

--
Mike Prestwood
Prestwood IT Solutions
Office (9AM to 4PM PST): 916-726-5675 x205 | Fax: 916-726-5676

Full approved member.
Member subscribes to this thread with a verified email.
Reply
More... -Collapse +Expand
About Mike Prestwood

Mike Prestwood is a drummer, an author, and creator of the PrestwoodBoards online community. He is the President & CEO of Prestwood IT Solutions. Prestwood IT provides Coding, Website, and Computer Tech services. Mike has authored 6 computer books and over 1,200 articles. As a drummer, he maintains play-drums.com and has authored 3 drum books. If you have a project you wish to discuss with Mike, you can send him a private message through his PrestwoodBoards home page or call him 9AM to 4PM PST at 916-726-5675 x205.

Web Presence
Facebook, Prestwood IT fan page. (Visit Me)
LinkedIn, My personal LinkedIn account for networking with IT professionals and coworkers. (Visit Me)
Website, My drum website where I sell my drum books. (http://www.play-drums.com)

Thread Started 1/29/2009 12:13:06 PM
View Counter=8003
Last Reply Posted 2/3/2009 11:06:49 AM)
Most Recent Post
Moderator
ASPGuy
Rank: Lieutenant

Joined: Jul 2007
Location: San Francisco, CA USA
ASPGuy -Collapse +Expand
Email Approved! E CA USA

Member Points: 158
Visits: 157
MB Posts: 45

KB Articles: 0
Replier... 2/3/2009

Good articles. Thanks.

--

Andy

Full approved member.
Member subscribes to this thread with a verified email.
Reply
More... -Collapse +Expand
About ASPGuy

I work for a large company in SF. I spend my days mostly doing analysis but code in asp and vb.net whenever possible.


Thread Started 2/3/2009 11:06:37 AM
New Thread
 
Thread #13255 Counter
8003
Since 1/29/2009
[Page Visitors]
Brought to you by Prestwood IT Solutions
We hope you are enjoying our message boards and invite you to post frequently. If you are interested in moderating, contact us. Our company is the caretaker of the PrestwoodBoards.com where we pay our staff to moderate, edit, and participate. Why? Online participation is fun, we enjoy sharing information, and this is our way of promoting our software development company. Keep us in mind if you or your company needs help.
 
779 People Online Now!!  
Online Now: Sign In to see who's online now!  Not a member? Join Prestwood now. It's free!