The Art of API Documentation: Best Practices for Writers

Register here

API documentation writing stands apart from traditional technical writing in its unique demands and audience expectations. Unlike typical technical documentation, API documentation necessitates a deep understanding of programming concepts and language to effectively connect with the audience.

In this session, Robert Delwood, Lead API Documentation Programmer-Writer at Walmart Global Tech will delve into seven best practices essential for crafting clear, concise, and effective API documentation.

Whether you’re a seasoned developer well-versed in APIs or new to the field, these practices will empower you to streamline your documentation.

Robert will discuss the following key concepts and share how they apply to best practices:

• Learn the theory, the rest are details. If you know where you’re going, the journey becomes easy.
• You write for yourself. You need to explain everything to yourself first before you can explain it to others.
• Examples are not just another thing, they’re the only thing. The importance of examples that writers overlook.
• Postman, Postman, Postman. It’s not a convenience, it’s a requirement.