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

Contact

Society for Technical Communication
11110 Sunset Hills Road | Reston, VA 20195
Email: Info@stc.org
TOP