API Documentation Best Practices – Full Course

this course covers everything you need to know to create automate and publish API documentation that your developers partners and users will love Jason Harmon developed this course Jason brings over 20 years of experience in the technology and API world and he's the CTO of stoplight hello free code Camp community and welcome to appek University and this course on API documentation best practices my name is Dan barahona co-founder of appek University and for the next 90 minutes or so you'll learn all about API documentation including how to write good doc good documentation techniques and tools for creating documentation and even the business impact of good documentation your instructor for the course is my good friend Jason Harman CTO of stoplight and one of the most recognized experts in this field I'd also like to invite you to check out all our free courses on appc University you'll find courses on API pen testing the oasp API top 10 API security environments really it's just fair to say that authorization and access control patterns are going to look pretty different for internal apis versus external and we'll talk talk plenty more trust me about the things that we need to pay attention to around off patterns and why they're so important but it is important to recognize that you're going to have a pretty different look on internal versus external facing um additionally for Internal Documentation you're often going to have a lot of proprietary information links to perhaps other knowledge stores on where to find out more about the implementation behind this or the team who's supporting it these sorts of things you might have operation metrics that are linked into this to point to how healthy is this thing should you trust it based on its track record of operational Health as we're in the external world you're often going to put a lot more effort into customizing The Experience putting stronger branding messaging and really some developer marketing this thing now I do think these external concerns are starting to creep into the internal world and a thought of this is not really the documentation writer's job per se but again we're trying to look at a total developer experience which really entails many aspects so these are just things to keep in mind