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 Latest KB Comments

Ordered newest to oldest.

To view comments to your KB Articles, go to your My Knowledge Base page. To view user contributions to your blogs, go to your My Blog page.

Showing first 10. Sign in to see more.

Read +Add Comment
Definitely not low stress. Also, no matter what the Bureau of Labor Statistics predicted back in 2008, the tech writing field is not growing. Salaries have dropped dramatically since 2008, and tech writer positions are scarce, largely due to outsourcing and cost-cutting in general. Tech writers are considered expendable and are the last to be hired and the first to be let go. Please do not encourage anyone to go into this declining field. --- Jane Doe
Posted 27 months ago
Regarding...
Rated by MSNBC.
Technical writing is an in-demand field and rated one of the top five high-paying, low stress jobs by MSNBC.
Read +Add Comment
Hi Neha, Thanks for your comments. --- Ramesh
Posted 36 months ago
Regarding...
Knowledge Management
An overview of knowledge management in corporate companies with the basics providing information peratining to such knowledge management teams that lead to greater organizational growth and individuals growth also.
Read +Add Comment
yeah. nice article. Moreover, there can be more frequent meet ups to share experiences and challenges. --- Neha Mittal
Posted 36 months ago
Regarding...
Knowledge Management
An overview of knowledge management in corporate companies with the basics providing information peratining to such knowledge management teams that lead to greater organizational growth and individuals growth also.
Read +Add Comment
I've been a tech writer in the software industry for 17 years. I don't think I'd generally classify this field as low stress. It depends on the project, company, resources, etc. And there is a difference between types of tech writing, e.g. SDK vs. system admin vs. consumer/end-user projects, going from very technical to simpler subject matter.  --- Derek
Posted 56 months ago
Regarding...
Rated by MSNBC.
Technical writing is an in-demand field and rated one of the top five high-paying, low stress jobs by MSNBC.
Read +Add Comment
Excellent insights, Peter. We need you over here at Venafi! --- Derek
Posted 5 years ago
Regarding...
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.,
Read +Add Comment
How can developers create API documentation that looks great like twilio? What are the tools to use? --- samwize
Posted 6 years ago
Regarding...
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.
Read +Add Comment
Great article, Peter! Another intriguing tool is Pydocweb, which supports wiki-based editing of API documentation comments that are embedded in source files. The updated comments (once they go through an approval process) go back into the source files in source control. This system is designed for Python source files, but the same idea could be applied to any programming language (just a "small matter of programming"). This tool has been used very successfully to improve the API documentation for the NumPy library. --- Janet Swisher
Posted 7 years ago
Regarding...
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. 
Read +Add Comment
I enjoyed reading this article especially the tips for clarifying API docs "If an XML element is a date, you should specify the format of the date. If it's a time, then you need to specify its time-zone. When specifying parameters for the request, you may also need to specify extra information about format. For example, if a parameter is a string, are there any characters that it cannot contain? Are there limitations on its length?" These tips are IMHO relevant for all APIs not just Web. Thanks for taking the time to compile this resource. Debbie Korn --- @debbiedocs
Posted 7 years ago
Regarding...
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.
Read +Add Comment
A very good article which highlights the needs for good Web API documentation as we move towards a cloud computing world where SaaS becomes important. --- Satish Vinjamuri
Posted 7 years ago
Regarding...
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.
Read +Add Comment
I do think you need to make a distinction between API design and API documentation. You're right that the writer should really be involved in the design process, but the reality is that just doesn't happen very often in industry. The writer is typically brought in at the tail end of the process. Diagrams -- yes, they can be useful. They just didn't make it into the top five. Context is important, too. I believe you could see that best through good sample code.
Posted 7 years ago
Regarding...
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. 

-
   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]