IT SOLUTIONS
Your full service 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:

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

Technical Writing New and Updated KB Posts

Page Contents


Recently Created

(Technical Writing Group)

  KB Article    

Ramesh R
1. Conceptual Thinking

Conceptual thinking deals with conceptualization theory and helps in assessing or dealing with complex situations. This is very important especially while working with user documentation projects or while performing writing of content.

Posted to KB Topic: Technical Writing
5 years ago

Article
Nothing New Since Your Last Visit
1808
Hits

Peter Gruenbaum
2. API Documentation Survey Results

In a perfect world, API documentation would contain clear, complete instructions on everything that developers need to know to use your platform. In reality, organizations have limited time and budget to create API documentation, and so organizations need to prioritize to create documentation that is most useful to the people who will use it.

SDK Bridge set out to find out what is most important to the people who use APIs by sending out a survey and asking them. We found, not surprisingly, that many thought that documentation could be better. When asked to rate quantitatively, people rated overviews, sample code, and API references the highest, followed closely by tutorials. When asked for open-ended comments, a large percentage mentioned working sample code as helpful, and an equally high percentage mentioned how important it is that documentation be complete and accurate. Two other important factors that were mentioned by several respondants are (1) it is very helpful to explain why you would use something in addition to how you use it and (2) completeness and accuracy are critical.

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

Article
Nothing New Since Your Last Visit
5211
Hits

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

lowster11
4. 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
4915
Hits

Peter Gruenbaum
5. 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
20060
Hits

Ramesh R
6. 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
10082
Hits

Ramesh R
7. Social Media in Technical Communication http://www.tcworld.info/index.php?id=130
Posted to KB Topic: General, Getting Started, etc.
7 years ago

Link
Nothing New Since Your Last Visit
4647
Hits

Julia Bertschinger
8. Teaching old thumbs new tricks - Tech Writing Blog

When I took a typing classs (not a keyboarding class, and yes, I know that dates me) I was taught that words had one space between them and sentences had two spaces in between them. Therefore, my thumbs, whose only job was to hit the space bar, learned that when a period was the last key typed, they had to hit the space bar twice instead of only once. They were good at this and were quite proud of their skill.

Now the rules have changed. The convention, especially for�material to be read on a screen, is that sentences have only one space between them. My thumbs have been rebelling. When I type, they want to put TWO spaces after a period. When I am typing something formal, in addition to checking my spelling and grammar, I also need to�check how many spaces are between each sentence.

Luckily, my thumbs are starting to adjust, and I am finding fewer and fewer double spaces between sentences. Thumbs can learn new tricks.

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

Blog
Nothing New Since Your Last Visit
5723
Hits

Julia Bertschinger
9. Its vs. it's

"It's" always means "it is."

"It's," unlike pretty much all other words with an apostrophe and an "s", does not ever indicate a possessive.

"Its" is the possessive, strangely enough.

"It's a good program.": The same as "It is a good program."

"It's features are impressive.": The same as "It is features are impressive," which is wrong.

"Its features are impressive.": Correct!

Posted to KB Topic: Grammar
8 years ago
(1 Comments , last by Himanshu.M )

Tip
Nothing New Since Your Last Visit
5853
Hits

Peter Gruenbaum
10. 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
14913
Hits




Recently Updated

(Technical Writing Group)

  KB Article    

Ramesh R
1. Conceptual Thinking

Conceptual thinking deals with conceptualization theory and helps in assessing or dealing with complex situations. This is very important especially while working with user documentation projects or while performing writing of content.

Posted to KB Topic: Technical Writing
5 years ago

Article
Nothing New Since Your Last Visit
1808
Hits

Peter Gruenbaum
2. API Documentation Survey Results

In a perfect world, API documentation would contain clear, complete instructions on everything that developers need to know to use your platform. In reality, organizations have limited time and budget to create API documentation, and so organizations need to prioritize to create documentation that is most useful to the people who will use it.

SDK Bridge set out to find out what is most important to the people who use APIs by sending out a survey and asking them. We found, not surprisingly, that many thought that documentation could be better. When asked to rate quantitatively, people rated overviews, sample code, and API references the highest, followed closely by tutorials. When asked for open-ended comments, a large percentage mentioned working sample code as helpful, and an equally high percentage mentioned how important it is that documentation be complete and accurate. Two other important factors that were mentioned by several respondants are (1) it is very helpful to explain why you would use something in addition to how you use it and (2) completeness and accuracy are critical.

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

Article
Nothing New Since Your Last Visit
5211
Hits

lowster11
3. 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
4915
Hits

Peter Gruenbaum
4. 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
20060
Hits

Peter Gruenbaum
5. 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
9365
Hits

Ramesh R
6. 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
9604
Hits

Peter Gruenbaum
7. 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
14913
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
10082
Hits

Ramesh R
9. Social Media in Technical Communication http://www.tcworld.info/index.php?id=130
Posted to KB Topic: General, Getting Started, etc.
7 years ago

Link
Nothing New Since Your Last Visit
4647
Hits

Julia Bertschinger
10. Teaching old thumbs new tricks - Tech Writing Blog

When I took a typing classs (not a keyboarding class, and yes, I know that dates me) I was taught that words had one space between them and sentences had two spaces in between them. Therefore, my thumbs, whose only job was to hit the space bar, learned that when a period was the last key typed, they had to hit the space bar twice instead of only once. They were good at this and were quite proud of their skill.

Now the rules have changed. The convention, especially for�material to be read on a screen, is that sentences have only one space between them. My thumbs have been rebelling. When I type, they want to put TWO spaces after a period. When I am typing something formal, in addition to checking my spelling and grammar, I also need to�check how many spaces are between each sentence.

Luckily, my thumbs are starting to adjust, and I am finding fewer and fewer double spaces between sentences. Thumbs can learn new tricks.

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

Blog
Nothing New Since Your Last Visit
5723
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]