IT SOLUTIONS
Your TECHNOLOGY partner! 
-Collapse +Expand
Tech Writer
Search Tech Writer Group:

Advanced
-Collapse +Expand Tech Writer Store

Prestwood eMagazine

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

   ► KBRole-Based T...Technical Wr...     Print This   
Go To Random Article
  From the July 2009 Issue of Prestwood eMag
 
Tech Writer Technical Writing:
Survey on SDK Documentation
 
Posted 48 months ago on 6/9/2009
Take Away:

A survey was sent to software developers and other software professionals to ask what was important in SDK documentation and where they would like to see improvement. The results indicated that the current state of typical SDK documentation is "Fair", which was the middle choice of five ("Excellent" to "Unusable"). The answers to multiple choice questions indicated that overviews, API references, sample code, and tutorials were all considered high importance, whereas blogs and forums were considered less important. When asked to write what they considered important, sample code was mentioned in 61% of the responses and overviews were mentioned in 30% of the responses. Also mentioned as important were help getting started, explanations of why something should be used, accuracy of information, and the ability to find information easily.




Comments

1 Comments.
Share a thought or comment...

Anonymous
Comment 1 of 1

Yes, Absolutely technical writer plays major role and each and every discussion of the software development technical writer should be so that they can write SDK accurately................. As I was working for technical writer.....................

---
Rupa
Posted 43 days ago
 
Write a Comment...
Full Editor
Sign in...

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


Anonymous Post:

Enter your name and security key.

Your Name:
Today's security key = P194A
Enter key:
Article Contributed By Peter Gruenbaum:

Peter founded SDK Bridge to bring together his love of technology and writing. He has worked as a programmer writer to describe technologies as diverse as the Tablet PC, mobile phones, and Live Framework. As a software developer, he has written software using Tablet PCs, Augmented Reality, 3D visualization, and computer-aided design. At Red Llama, he created a program to teach creative technology classes to low-income youth to inspire them to consider technology careers, obtaining grant money from the Gates Foundation, Microsoft, and others. This program has now become the "Software Development for Kids" project at SDK Bridge. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University .


 KB Article #102002 Counter
9342
Since 6/9/2009
-
  Load Time=1 seconds.
 
Print This

KB Post Options:
-
 
Have a question? Need our services? Contact us now.
--Mike Prestwood

Call: 916-726-5675

email: info@prestwood.com


829 People Online Now!!  
Online Now: Sign In to see who's online now!  Not a member? Join now. It's free!
Show More...


©1995-2013 PrestwoodBoards  [Security & Privacy]
Professional IT Services: Coding | Websites | Computer Tech