Part 2 in API Series: Documenting Java and C++ APIs

Speakers

Ed Marshall
Presenter

Start

February 25, 2015 - 2:00 PM

End

February 25, 2015 - 3:00 PM

Address

9401 Lee Highway, Suite 300, Fairfax, VA 22030   View map

Documenting application programming interfaces (APIs) and software development kits (SDKs) is a constantly growing field. The supply always exceeds the demand of writers who have the skills to succeed in this challenging, rewarding niche. During this webinar, Ed Marshall, an expert in API/SDK documentation, will introduce you to this field and the skills you need to shine. The topics he will cover are:

  • The level of programming knowledge you should know to be successful.
  • How much information you can gather from reading code and where to go for additional details.
  • The two most common tools used in API/SDK documentation – Doxygen and Javadoc.

Ed will also show examples of real-world APIs and demonstrate how Doxygen and Javadoc work. Both tools extract software developers’ comments from the code and formats the comments into an online help format.

MORE DETAIL

Website

www.stc.org

Phone

+1 (703) 522-4114

Email

education@stc.org

Career Center

Find your next job/contract opportunity here! Look at the STC Job Bank and get 14-day advance access to the newest employment opportunities.

Publications

Access to our industry-leading publications: Intercom, Technical Communication journal, STC’s Notebook blog, newsletters, and the Body of Knowledge (TCBOK).

Education

The educational opportunities that STC members gain access to offer a breadth of continuing education knowledge in a variety of formats including webinars, online courses, Summit sessions, and more.

Community

Leverage the power of members from around the world. Build relationships, advance your career through STC’s global community of technical communicators.

Contact

Society for Technical Communication
Phone: +1 (703) 522-4114 | Fax: +1 (703) 522-2075
3251 Blenheim Boulevard | Suite 406 | Fairfax, Virginia 22030
Email: STC | Map it!

About

The Society for Technical Communication advances technical communication as the discipline of transforming complex information into usable content for products, processes, and services.

TOP