The April 2007 Chapter Meeting
Date:
Wednesday, April 11, 2007
Times:
6:00 p.m. Networking
6:30 p.m. Dinner
7:15 p.m. Announcements
7:30 p.m. Presentation
9:30 p.m. End
Location:
Topic:
Shattuck Plaza Hotel, 2086 Allston Way, Berkeley, California
Automating API Documentation, and a DoxyS Case Study
API Documentation is a fast-growing and highly-paid specialty in Technical Writing. As Monique Semp explains, you can write an API Reference in FrameMaker and publish it as a PDF, but such a document is difficult to maintain and unlikely to satisfy your target audience: programmers. Programmers expect online, hyperlinked reference material that's exactly in sync with the API elements (such as classes and functions).
This presentation shows how to use automated tools to generate an HTML-formatted API Reference. Monique will give us an overview of automating an API reference's production and tell us the advantages of such an approach over a manual solution such as FrameMaker-to-PDF. She will give us guidelines for choosing the right tool, and discuss concerns such as imposing coding standards and workflow changes on the engineers. She will demonstrate how this all worked when, using DoxyS, she developed an API Reference for a 700+ function ANSI C API.
Speaker:
A Senior STC member, with more than 15 years of documentation and software experience, Monique has won STC Touchstone and Berkeley competition awards of merit and excellence every year since 2001. Monique began her career as a software engineer writing PL/M and C code for automated train control (the "people movers" in airports) and the accompanying user manuals. Her career evolved and she's been a technical writer since 2001; her first project was producing API documentation for Java-based wireless applications. She has her own company, Write Quick, Inc., and provides many technical writing services, including API references, programming guides, configuration manuals, and technical processes and procedures.
Continuing in April, 2007 we will meet in the Town Room (on the second floor) of the
Shattuck Plaza Hotel in Berkeley, CA.
If you have a suggestion for a meeting topic you'd like to hear more
about or if you'd like to be a presenter, send an email to
Mary Ann Campbell, VP of Programs.
Note: If you do not reserve dinner in advance, dinner may or may not be available on a walk-in basis. We order dinner for the number of reservations plus a few walk-ins.
NOTE ONE: Non-members are always welcome to STC meetings.
NOTE TWO: All members of the San Francisco Chapter of the IABC are welcome to register for Berkeley STC General Meetings at the member price.
If you wish to pay by cash or check, send email to that effect to treasurer@stc-berkeley.org, and then bring payment to the meeting.
If you wish to pay be credit card, please reserve using our online storefront.
Interested in becoming a member?
*Attendees are
encouraged to announce open positions. Please bring job
listings for distribution. Recruiters may introduce
themselves, but may not describe open positions in detail.
Save that for one-on-one after the program.
The Shattuck Plaza Hotel is located at 2086 Allston Way in downtown
Berkeley, immediately west of Shattuck Ave. We meet in the Towne Room
on the second floor.
Monique Semp
Monthly Chapter Meetings
The Berkeley chapter meets the second Wednesday of the month.
Chapter Meeting Program Ideas?
Chapter Meeting Fees
For the meeting and dinner, reserved on the Chapter's website in advance:
For the meeting and dinner at the door:
To attend the program only:
Chapter Meetings Agenda
Location and Directions
Shattuck Plaza Hotel
2086 Allston Way
Berkeley, CA
The Shattuck Plaza Hotel in Downtown Berkeley, just off of Shattuck
The hotel is within walking distance from the Berkeley BART station; meter parking on the street is free after 6:00 p.m.
The Shattuck Plaza Hotel Lobby
Directions to the Shattuck Plaza Hotel
By BART:
- Emerge from the Berkeley BART station.
- Walk south on Shattuck one block.
- Turn right on Allston.
- The Shattuck Plaza Hotel is on the left.
By car:
- Metered parking on the street is free after 6:00 p.m.
From north of Berkeley: I-880 south and get off at the University Avenue exit. Follow University east to Shattuck and turn right. Allston is three blocks south of University, and the Shattuck Plaza Hotel is on the South side of the street.
From south of Oakland: SOUTH: Take I-880 north to downtown Oakland, and then bear right onto I-980. Take the Martin Luther King exit and bear left to merge onto Martin Luther King Way. Turn right onto Adeline just past the sharp curve. Adeline will merge into Shattuck Avenue. Turn left on Allston and the hotel will be on the left side of Allston.
From San Francisco: Take the Bay Bridge towards Oakland (I-80 East). At the end of the bridge, take I-80 east towards Berkeley. Get off at the University Avenue exit. Follow University east to Shattuck and turn right. Allston is three blocks south of University, and the Shattuck Plaza Hotel is on the South side of the street.
From far East Bay:
Take Highway 24 West through the Caldecott Tunnel. Exit at Highway 13 north towards Berkeley. Turn right on
Shattuck Avenue. Turn left on Allston and the hotel will be on the left side of Allston.
Last updated Friday, April 25, 2008.
© 2005-2008, STC-Berkeley Chapter
Please email web-page corrections or web-page comments to:
-
Berkeley STC Webmaster
Jim Dexter (internet@stc-berkeley.org)
East Bay Chapter
North Bay Chapter
Sacramento Chapter
San Francisco Chapter
|
|
Silicon Valley Chapter
STC Region 8
STC International Headquarters
|