STC Summit 2017 has ended
Back To Schedule
Tuesday, May 9 • 9:00am - 9:50am
Writing Complete APIs

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Web applications (particularly those using REST) have taken off, replacing traditional client side applications. That API technology far outpaces documentation technology. Many new writers have come to rely on automated documentation systems (such as Swagger, Sand Castle, and Visual Studio’s Summary XML tags). But they are not complete. Relying solely on those tools forms only a partial API suite. The truth is the suite is a combination of several disciplines. Robert’s session goes back a step and puts API documentation in proper perspective. It outlines the requirements of API documents, such as the difference between an API and SDK (software development kit), the parts of an API, the methods description page, how automated tools can make this better (or worse), and the relationships between the writer, developer, and reader. You don’t need programming or scripting experience although those with familiarity may benefit the most.

avatar for Robert Delwood

Robert Delwood

Sr. User Assistance Developer, SAP
Robert Delwood is a programmer, writer, and programmer-writer currently in Chicago but formerly with NASA's Johnson Space Center. He's passionate about technical writing, API documentation, and Office automation. With more than 18 years experience, he's written about and documented... Read More →

Tuesday May 9, 2017 9:00am - 9:50am EDT
Baltimore 3