Senior technical writer at MongoDB
Unclear documentation can lead to more adoption friction and often means that organizations with larger deployments face challenges with using your application at scale. At MongoDB, the API documentation was difficult to use. When trying to update that documentation, Anthony and colleagues discovered that how they managed those docs was unsustainable. In trying to help their users scale, they saw that they needed to help themselves scale the documentation:
Developer and Product Manager
APIs need good documentation, and to keep your reference docs up-to-date you need to test them. Dredd is a program that tests API references in specification languages Swagger/OpenAPI Initiative and API Blueprint.
Jessica talks about how to use Dredd in practice and some of its perks, like:
Check out: Keeping documentation honest - an article recommended by Jessica.
Technical Lead of Nexmo Developer
Adam talked about the open-source platform and tools they built when developing Nexmo Developer, for writing rich documentation collaboratively with ease. He talked about how they tackled problems concerning documentation requirements and met their goals.
Read Adam’s article on Extending Markdown with middleware.
Stunning (API) Docs == + appealing appearance + content structure + clear instructions + proper & consistent gramm… https://t.co/U7ITSOAh8j