Q: How does the course work? Do students log in once a week? Every day? What time do the lessons start?
A:
Because the course is virtual, students can spend as much time
on any particular lesson as they wish.
Each week we focus on one lesson. Students post to that lesson's discussion
forum and have assignments due for that week by the following Monday morning
at 9 a.m. Pacific Time.
We also have three teleconferences during the course, which are scheduled
so that as many of the students as possible can participate in the actual
call. A recorded version of the teleconference is archived so students who
can't participate can review it.
Q: How much study time should I allow?
A:
We estimate the time commitment for most students to be four to six hours of work a week.
Q: Do I actually write any API docs as part of the course?
A:
Yes. As part of the course, you generate two Javadoc reference guides.
In addition, you write a critique of both a reference guide and
a programmer's guide of your choice. If your company's API docs
are publicly available, we encourage you to use one of these
documents as the subject of your critique.
Q:How is the training priced?
A:
Our goal is to provide our students with outstanding value for their money and a unique learning experience.
In addition, we must compensate our instructors and cover the overhead associated with the training.
We sometimes offer new trainings at a "beta price" for the first one
of two times the training is offered. Because we ask for a lot of
feedback during these beta trainings and we are typically still working
out the curriculum and other issues, the price is significantly discounted.
For questions or to be placed on the mailing list for information about future trainings, send Viki an email or call the office at 510.234.4046.
Registration is open for Session 1 2008 of “Introduction to Developer Documentation,” our introductory documenting Java APIs course.
Session 1 2008 dates are Monday, March 3, 2008, through Wednesday, April 23, 2008. Note that the course is limited to 12 participants. Please register early to ensure a space in the training.
Please note that we schedule sessions of “Introduction to Developer Documentation” based on demand, which means when we have enough people on our "interested list." If you are interested in this training, send Viki an email with your name and "interested in training" as the subject line. We anticipate scheduling another session of the training in September, but we will schedule an earlier training if demand warrants it.
Complete the registration form and email it to vmaki@bitzone.com.
Introduction to Developer Documentation is an introductory course in documenting Java APIs for individuals either new to writing developer documentation or who wish more guidance and structure than that provided by self-study of our book.
The course uses Documenting APIs: Writing Developer Documentation for Java APIs and SDKs as the textbook and also incorporates the four sample code projects and a course study guide. Download the syllabus for the course.
Introduction to Developer Documentation covers interfaces, APIs, API documentation, and setting up your environment to create a Javadoc reference guide.
For 2008, we are including three 90-minute phone conferences with the instructors as part of the course. These three phone conferences are scheduled to coincide with lesson 1, lesson 3, and lesson 5 and cover, respectively:
The course includes two lessons where you generate a Javadoc reference guide, first for a simplified API, the Pets project, and then for the TAFT project. The TAFT project, one of four sample code projects included with the book, demonstrates how an application can expose a plug-in API. Generating a Javadoc reference guide ensures that you have your environment configured correctly as well as that you understand the workflow typically used in developer documentation, which includes using a text editor, a DOS window, the Ant build tool, and Javadoc.
Lesson 4 covers the research necessary to prepare for the initial interview with the SME in which you typically discuss a high-level overview of the API. Lesson 5 covers conducting the interview, including objectives and a list of questions to ask during the interview. The course culminates in lesson 6, which covers writing the reference guide and the programmer's guide.
The course is held entirely online using an open source LCMS (learning content management system), email, and phone.
We advise that students have about three years of technical writing experience. No programming language experience is necessary. If you have questions about whether the course is right for you, contact Viki.
To participate in the course, you need a computer running Windows. If you are running Linux or Macintosh OSX, contact Jim at jbisso@bitzone.com before you register. You also need a broadband Internet connection and an email address.
Tuition for the course is $525, which includes the course, the textbook and study guide, three phone conferences, sales tax, and domestic postage (a $65 value).
Already own the book? Deduct $65.
STC members receive a $20 discount on the training.
“The online training format was very helpful. I could easily attend the session from my home.”
Revathi Sampath
Program and Events Manager
STC Silicon Valley Chapter
“What I liked most about the training was the excellent design of the course. The interplay between the book, the lectures, discussion forums, and the exercises was an extremely effective way to learn. ”
Jessie Evans
Technical Writer, Phoenix Technologies
Milpitas, CA
Lesson 1: Introduction and Understanding Interfaces
Lesson 2: An Introduction to Developer Documentation
Lesson 3: Setting Up Your Environment and Using Javadoc
Lesson 4: Preparing for the Initial Interview with the SME
Lesson 5: Conducting the Initial Interview with the SME
Lesson 6: Writing the Guides