What is a REST API?

About web services

In general, a web service is a web-based application that provides information in a format consumable by other computers. Web services include various types of APIs (Application Programming Interfaces), including both REST and SOAP APIs. Web services are basically request and response interactions between clients and servers (one computer makes the request, (Read more...)

Proposals for 2016 *STC Silicon Valley Chapter* presentations now accepted

Are you interested in presenting to the Silicon Valley STC Chapter this year? We're now accepting proposals for 2016 speakers.

STC Silicon Valley Chapter presentations

What presenting involves

Presenting to the STC Silicon Valley Chapter (located in the South Bay of the San Francisco, California) involves the following:

  • Preparing a 1-hour presentation relevant to technical writers
  • Preparing some slides or (Read more...)

My process for creating vector diagrams with Illustrator

Create the file in Adobe Illustrator

Adobe Illustrator is my preferred tool for creating diagrams, conceptual workflows, or any other graphic that's not a screenshot. This is because Illustrator creates vector graphics, whereas other applications (e.g., Snagit, Photoshop) create raster graphics.

Vector graphics are actually XML files that are mathematically drawn, whereas raster graphics are (Read more...)

Version 3.0 of my Documentation theme for Jekyll released

Version 3.0 released

Version 3.0 of my Documentation theme for Jekyll is now available. You can download the source code from the theme's Github repo.

To see an example of the single sourced outputs, see the following:

The Designers output has detailed instructions for working with the theme.

Documentation theme screenshot

The Writers (Read more...)

Back to Top | Comments Off on Version 3.0 of my Documentation theme for Jekyll released

Question: What qualities should technical writers have to work at startups?

Question from recruiter

A recruiter recently asked me what traits technical writers should have for startup companies. Startup environments post unique challenges when it comes to technical writing. Here are a few thoughts about the characteristics technical writers need to succeed in this environment.

1. Technical aptitude

You need to be strong enough technically to (Read more...)

Back to Top | Comments Off on Question: What qualities should technical writers have to work at startups?

Other Stuff