• Documentation Mystery?
    • Privacy Policy
  • Need Multi-Skilled Writer?
  • What Services Does Your Business Need?
  • Excellent Work Product Samples!
  • Current Events
  • Contact Us for Support and Free Newsletter

Technical Connections

TechConnTechnical Connections is technology staffing firm. Established in 1984, they have a track record and network that is second to none.

I worked for Technical Connections’ customer, Universal Electronics, Inc., to update and edit a Web Services Guide, which was an API guide. There were five tasks involved in this short-term assignment as follows:

  • Extract new APIs from Doxygen, copy and paste each into the guide, and edit.
  • Check the existing APIs in the guide against the Doxygen files to ensure that the content was identical.
  • Create examples of requests and responses for each new API.
  • Work with the development team to make the content more clear and understandable.
  • Reformat the guide adding an overview with a cross referenced list of headings in the overview, and add a documentation history table which included date and version number.

Visit the Technical Connections website at http://tci-la.com/ and Universal Electronics, Inc. website at http://www.uei.com.

Sample

This sample shows three stages of the writing of a user guide for Web Services capturing RESTful, JSON, and XML APIs.

  • ABCCompanySample

Best Regards,
Alex
alex@aboutwritingandstyle.com
949-269-7809

Follow meFollow on FacebookFollow on Google+Follow on TwitterFollow on LinkedIn

Search

Recent Posts

  • Poor Project Managers Break Projects
  • Is DITA Appropriate for Your Business?
  • InfoDev Professionals are True Detectives
  • Recruiters – Good or Bad?

Related Posts

About Writing & Style, Copyright 2015