IT SOLUTIONS
Your full service technology partner! 
-Collapse +Expand
Tech Writer
Search Tech Writer Group:

Advanced
-Collapse +Expand Tech Writer Store

Prestwood eMagazine

August Edition
Subscribe now! It's Free!
Enter your email:

   ► MB LobbyTechnical Writing BoardTech Writing Topic   Print This    All Groups  

Couple New Articles

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

Quick Search: Articles   Couple New   Couple New Articles  
Moderator
Mike Prestwood
Prestwood IT
Prestwood IT office in Citrus Heights, CA

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

 Posted 8 years ago (Thread Starter)
Comment Quote
About Mike Prestwood -Collapse +Expand
Visit Profile
Approved member.
Member subscribes to this thread with a verified email.
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 Facebook page -- fan page. (Visit Me)
Twitter, Follow Prestwood IT on Twitter. (Visit Me)
LinkedIn, Prestwood IT company page on LinkedIn. (Visit Me)
YouTube, Prestwood IT YouTube Channel (Visit My Channel)
Website, My drum website where I sell my drum books. (http://www.play-drums.com)

Post ID #13255, 1 replies
Thread Started 1/29/2009 12:13:06 PM
View Counter=192404
Last Reply Posted 2/3/2009 11:06:49 AM)
Location=Prestwood IT office in Citrus Heights, CA 
Joined=17 years ago   MB Posts=1409   KB Posts=1805   KB Comments=92   BLOG, Topics=4  
Most Recent Post
ASPGuy
San Francisco, CA USA

Good articles. Thanks.

--

Andy

 Posted 8 years ago
Comment Quote
About ASPGuy -Collapse +Expand
Visit Profile
Approved member.
Member subscribes to this thread with a verified email.
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.


Post ID #13267 (Level 1.1)  Reply to 13255
Thread Started 2/3/2009 11:06:37 AM
Location=San Francisco, CA USA 
Joined=10 years ago   MB Posts=48   KB Comments=5  

Revive Thread!

Add a comment to revive this old thread and make this archived thread more useful.

Write a Comment...
Full Editor
...
Sign in...

If you are a member, Sign In. Or, you can Create a Free account now.


Anonymous Post (text-only, no HTML):

Enter your name and security key.

Your Name:
Security key = P1223A1
Enter key:
Icon: A Post    Thread    Idea    Important!    Cool    Sad    No    Yes    Includes a Link...   
Thread #13255 Counter
192404
Since 1/29/2009
-
   Contact Us!
 
Have a question? Need our services? Contact us now.
--Mike Prestwood

Call: 916-726-5675

email: info@prestwood.com


Go ahead!   Use Us! Call: 916-726-5675 


©1995-2017 Prestwood IT Solutions.   [Security & Privacy]