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

Advanced
-Collapse +Expand Tech Writer Store

Prestwood eMagazine

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

   ► KB ►► Role-Based T...Technical Wr...   Print This    All Groups  

Technical Writing Most Read KB Posts

Page Contents


Most Read KB Articles Since 3/28/2008

Technical Writing Group

  KB Article    

Peter Gruenbaum
1. Web API Documentation

The number of Web APIs is growing rapidly, especially with the increasing popularity of Software as a Service. Because Web APIs are still fairly new, the quality and format of their documentation varies a great deal. Good documentation is important for Web APIs because experimentation is more difficult than with local APIs. Because Web APIs are language-neutral, you may need to write sample code in a variety of different languages. Be sure to cover authentication, error handling, and HTTP information.

Posted to KB Topic: Technical Writing
7 years ago, and updated 7 years ago
(3 Comments , last by Anonymous )

Article
Nothing New Since Your Last Visit
19504
Hits

Peter Gruenbaum
2. Survey on SDK Documentation

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.

Posted to KB Topic: Technical Writing
8 years ago

Article
Nothing New Since Your Last Visit
18179
Hits

Peter Gruenbaum
3. 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.

Posted to KB Topic: Technical Writing
8 years ago
(1 Comments , last by Anonymous )

Article
Nothing New Since Your Last Visit
14846
Hits

Peter Gruenbaum
4. The Five Biggest API Documentation Mistakes and How to Avoid Them

Good API documentation can have a tremendous impact on whether a software platform is adopted. However, too often API documentation ends up being confusing and hard to follow, which results in developers choosing another way to accomplish their goals. This article describes five common mistakes that are made in creating API documentation and describes solutions to avoiding those mistakes. Following good API documentation practices can provide developers with the content that they need to be able to take full advantage of a software platform's capabilities. 

Posted to KB Topic: General, Getting Started, etc.
8 years ago, and updated 7 years ago
(9 Comments , last by peter2 )

Article
Nothing New Since Your Last Visit
14464
Hits

Mike Prestwood
5. 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.
Posted to KB Topic: Publishing
9 years ago, and updated 9 years ago

KB Post
Nothing New Since Your Last Visit
12193
Hits

Peter Gruenbaum
6. Using Real World Scenarios in Conceptual Documentation

Using real world scenarios when you write conceptual documentation for Software Development Kits (SDKs) is a way to give your readers ideas as to how the SDK can be used and to guide them as to what APIs are needed for commonly expected scenarios. This article guides you through how to gather information about scenarios, how to simplify them in order to make good examples, and how to lead developers through which APIs to use.

Posted to KB Topic: Technical Writing
8 years ago

Article
Nothing New Since Your Last Visit
11580
Hits

Ramesh R
7. Critical Thinking in technical writing

Critical Thinking skills comes automatically as a writer becomes experienced over a period of time. Learning to write and transforming the ideas into writing help develop critical thinking aspects/skills. A clear set of phases/activities are inititated in the human brain as part of critical thinking. This article helps to understand the learning basics, learning process and the impact of writing that drives critical thinking skills. This is a good read for all our technical writing friends across the globe.

Posted to KB Topic: General, Getting Started, etc.
7 years ago

Article
Nothing New Since Your Last Visit
9712
Hits

Ramesh R
8. Quick Tips: Writing a Marketing Plan

Marketing plan is the first prerequisite once the company decides with bringing the product to the market. It is important to analyze market conditions, growth aspects before starting to release any product. A marketing plan document is a good start and plays a very important role in understanding the market better. This plan discusses several different aspects of marketing strategy.

Posted to KB Topic: General, Getting Started, etc.
9 years ago, and updated 7 years ago

KB Post
Nothing New Since Your Last Visit
9219
Hits

Peter Gruenbaum
9. Crowd-Sourcing API Documentation

Crowd-sourcing (that is, using Web-based technology to gather API documentation content from your users) has the potential to lower documentation costs and make your documentation more relevant. However, relying solely your developer community to provide documentation will result in uneven quality and coverage. I recommend a hybrid approach, where professional programmer/writers write parts of the documentation, as well as rewrite and polish content from the community. Several tools are available that enable communities to contribute documentation content. 

Posted to KB Topic: Technical Writing
7 years ago
(1 Comments )

Article
Nothing New Since Your Last Visit
8823
Hits

Ramesh R
10. Global Dashboard - Metrics for documentation processes This article presents an overview of the global dashboard and the related metrics for all regions, specifically for documentation teams. This helps the user to understand and gain more knowledge on the metrics, measures and quality standards used for content management, portal management, elearning systems teams.
Posted to KB Topic: General, Getting Started, etc.
9 years ago
(1 Comments , last by Anonymous )

Article
Nothing New Since Your Last Visit
8275
Hits



Most Read by Members

Technical Writing Group

  KB Article    

Peter Gruenbaum
1. The Five Biggest API Documentation Mistakes and How to Avoid Them

Good API documentation can have a tremendous impact on whether a software platform is adopted. However, too often API documentation ends up being confusing and hard to follow, which results in developers choosing another way to accomplish their goals. This article describes five common mistakes that are made in creating API documentation and describes solutions to avoiding those mistakes. Following good API documentation practices can provide developers with the content that they need to be able to take full advantage of a software platform's capabilities. 

Posted to KB Topic: General, Getting Started, etc.
8 years ago, and updated 7 years ago
(9 Comments , last by peter2 )

Article
Nothing New Since Your Last Visit
14464
Hits

Mike Prestwood
2. 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.
Posted to KB Topic: Publishing
9 years ago, and updated 9 years ago

KB Post
Nothing New Since Your Last Visit
12193
Hits

Peter Gruenbaum
3. Web API Documentation

The number of Web APIs is growing rapidly, especially with the increasing popularity of Software as a Service. Because Web APIs are still fairly new, the quality and format of their documentation varies a great deal. Good documentation is important for Web APIs because experimentation is more difficult than with local APIs. Because Web APIs are language-neutral, you may need to write sample code in a variety of different languages. Be sure to cover authentication, error handling, and HTTP information.

Posted to KB Topic: Technical Writing
7 years ago, and updated 7 years ago
(3 Comments , last by Anonymous )

Article
Nothing New Since Your Last Visit
19504
Hits

Ramesh R
4. API documentation - documenting the program code

Overview and tips for documenting an Application Programming Interface (API).

Posted to KB Topic: Technical Writing
9 years ago, and updated 8 years ago

KB Post
Nothing New Since Your Last Visit
5243
Hits

Peter Gruenbaum
5. Survey on SDK Documentation

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.

Posted to KB Topic: Technical Writing
8 years ago

Article
Nothing New Since Your Last Visit
18179
Hits

Peter Gruenbaum
6. 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.

Posted to KB Topic: Technical Writing
8 years ago
(1 Comments , last by Anonymous )

Article
Nothing New Since Your Last Visit
14846
Hits

Peter Gruenbaum
7. Using Real World Scenarios in Conceptual Documentation

Using real world scenarios when you write conceptual documentation for Software Development Kits (SDKs) is a way to give your readers ideas as to how the SDK can be used and to guide them as to what APIs are needed for commonly expected scenarios. This article guides you through how to gather information about scenarios, how to simplify them in order to make good examples, and how to lead developers through which APIs to use.

Posted to KB Topic: Technical Writing
8 years ago

Article
Nothing New Since Your Last Visit
11580
Hits

Ramesh R
8. Critical Thinking in technical writing

Critical Thinking skills comes automatically as a writer becomes experienced over a period of time. Learning to write and transforming the ideas into writing help develop critical thinking aspects/skills. A clear set of phases/activities are inititated in the human brain as part of critical thinking. This article helps to understand the learning basics, learning process and the impact of writing that drives critical thinking skills. This is a good read for all our technical writing friends across the globe.

Posted to KB Topic: General, Getting Started, etc.
7 years ago

Article
Nothing New Since Your Last Visit
9712
Hits

Ramesh R
9. Technical Writing Domains

A large set of technical writing work have grown up and it has started spanning across several domains. Documentation is strictly a requirement by most of the companies when we look at information management techniques as a whole. Over a period of time, the documentation changes need to be tracked and verified including the release changes and changes in development/API. Technical writing is not just limited to software or hardware or products as such. It is existing across several domains. Let us try to understand the various domains in which technical writing offers it role.

Posted to KB Topic: Technical Writing
8 years ago

Article
Nothing New Since Your Last Visit
6269
Hits

lowster11
10. Rated by MSNBC.

Technical writing is an in-demand field and rated one of the top five high-paying, low stress jobs by MSNBC.

Posted to KB Topic: Technical Writing
7 years ago
(2 Comments , last by Anonymous )

News
Nothing New Since Your Last Visit
4705
Hits
Icon Legend:
Since your last logged visit:
- New to you or updated since your last visit (sign in now to activate).
- NOT new to you since your last visit (sign in now to activate).
-
   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]