Swagger UI and the Open API Specification

Have you ever been interested in learning more about APIs and API documentation? It’s one of the fastest growing areas of technical communication, and it’s quickly becoming a common job requirement. APIs, or application programming interfaces, are sets of functions and methods that allow you to interface to a program or service running on another computer. APIs have become increasingly prevalent, and more technical writers are needed to document the core functionality of these APIs. Continue reading “Swagger UI and the Open API Specification”

Educational Opportunities with STC Webinars

As technical communicators it is always important to continue our education and enhance our skills.

One way to do this is to participate in the Society for Technical Communication’s webinars.

For those who are members of STC, there are several educational opportunities:

 

There are also several free archived seminars on a variety of topics such as designing tips, DITA, HTML5 and more. Be sure to check out these seminars and webinars to learn something new today.

An Aggressive Approach to Concise Writing

A webinar presented by Joe Welinske of WritersUA

STC-SM was offered a rare opportunity to view a webinar during the workday and it just so happened to be the same day that our BCBSM/BCN provider communications staff meeting was being held. Golden opportunity! My manager loved the idea, so we included the webinar in our agenda for the month.

Joe began by pointing out that the information and techniques that he would be discussing were developed to transition input that had been developed for laptops and desktops to formats for smaller devices such as PDAs, iPhones, Androids, tablets, etc. He said his goal is usually to pare the content down by two-thirds. He remarked that he teaches these techniques in his TC101 classes and I then recalled that we also did several exercises such as these in my Tech Comm classes. But he pointed out that this approach also helps to tighten your content for usability and readability for things like CBTs where you are writing in a small bubble or speaking in concise sentences. Continue reading “An Aggressive Approach to Concise Writing”

Review of Essential User Experience Skills Presented at the 2010 Summit by Will Sansbury, Rachel Peters, and Yina Li

Will Sansbury, Rachel Peters, and Yina Li based their presentation on a workshop they put together for members of the Atlanta chapter of STC. A team of chapter members was interested in redesigning the Atlanta chapter’s website, thus the need for the workshop. The Atlanta chapter website being used at that time was designed in approximately 1994.

The presentation overviews three essential user experience skills: card sorting, heuristic evaluation, and usability testing. Although the main focus of the presentation was how to put these skills into practice designing a website, references were also made to the importance of these same skills for designing user guides and online help as well. Continue reading “Review of Essential User Experience Skills Presented at the 2010 Summit by Will Sansbury, Rachel Peters, and Yina Li”

Letter from the Membership Manager

Announcing a New Batch of Local Casual Networking Events

Your local Southeastern Michigan chapter of STC is unveiling some new dates for upcoming casual networking events around the metropolitan Detroit and Ann Arbor areas. Some are lunches and some are happy hour events this time. Please RSVP in advance if you’ll be attending so we make sure to have enough seating available and so we can notify you if something changes. At these events, attendees are responsible for purchasing their own food/beverages, but the camaraderie and conversation are free!

  • Tuesday, February 25, 2014: Networking happy hour, 4–6 p.m., at Mr. Joe’s, 26077 West 12 Mile Road, Southfield. RSVP by noon on Monday, February24 to [email protected].
  • Friday, March 7, 2014: Networking lunch, 11:30–1:00, at Palm Palace, Carpenter Rd., Ann Arbor area. RSVP by noon on Thursday, 3/6 to [email protected].
  • Wednesday, March 19, 2014: Networking happy hour, 4–6 p.m., at Doc’s Sports Retreat on Victor Parkway in Livonia (off I-275 and 7 Mile). RSVP by noon on Tuesday 3/18 to [email protected].
  • Thursday, April 17, 2014: Networking lunch, 11:30 -1:00, at Niki’s, 735 Beaubien (Greektown) in Downtown Detroit. RSVP by Wednesday, April 16 to [email protected].
  • TBD: Another networking event for Detroit’s northern suburbs…stay tuned for date and place.

Free STC Webinar: Using STC Resources to Find Employment

  • Presenter: Dr. Jackie Damrau
  • When: Tuesday, February 18, 2014
  • Time: 12:30-1:30 p.m., EST

To register, send an email to [email protected]

Description

STC members will learn how to use STC website resources to help them in finding their ideal job. We start off by covering the Ten Tips to Your Ideal Dream Job with the associated STC website resources used to supplement each tip. We then conclude by quickly walking through Four Career Search Tips for What Not To Do, and the 80/20 Rule During Interviews.

About Dr. Damrau

Dr. Jackie Damrau is a Sr. Business Systems Analyst at CBRE. In her current role, Jackie models business processes and other department workgroup processes using BPMN modeling notation for determining workflow automation of existing paper-based processes or improving existing business processes. Jackie has more than 25 years of technical communication experience. She is a Fellow of the Society for Technical Communication (STC), member of the STC North Texas Lone Star chapter and the Instructional Design and Learning SIG, and the Book Review Editor for Technical Communication. Jackie’s past international positions have been as a SIG manager for the Instructional Design and Learning SIG; assistant SIG manager for the Management SIG; elected member of the Nominations Committee; and general manager of the STC International Summit Awards (2010-2012). Jackie enjoys reading literature, sociology, linguistics, and philosophy. Find her on LinkedIn (http://www.linkedin.com/in/jackiedamrau) or on Twitter (@damrauja).

—Mary Jo David, STC-SM Membership Manager