December 2022 Summaries

ReadMe has introduced "api," an open-source SDK generator designed to enhance developer experience by simplifying API calls and reducing boilerplate code. Built on the OpenAPI specification, api allows developers to generate custom SDKs tailored to specific APIs, offering a more streamlined and intuitive approach compared to generic HTTP clients like Fetch. This innovation aims to meet developers where they are, accommodating diverse needs and technical stacks, while promoting faster and more successful initial API calls. The api SDK abstracts complexity and leverages TypeScript definitions for better code completion, making it easier for developers to interact with APIs. By integrating seamlessly into existing OpenAPI-powered documentation, api not only improves the readability of code snippets but also enhances security, request parameter handling, and response parsing, thus significantly elevating the overall developer experience.

Beth Favini, currently the Senior Director of Product Documentation at Couchbase, shares her career journey and insights into technical writing, emphasizing the value of asking questions and leveraging diverse backgrounds in the field. With a background in English and an initial career direction towards teaching, Favini pivoted to technical writing, where she learned to embrace her analytical skills despite not having a technical education. Her career path included significant roles at Akamai, where she integrated UX writing within a User Experience team, and her leadership skills evolved through a mix of individual contributions and management positions. Favini highlights the importance of developing API skills for modern technical writing roles and encourages aspiring writers to educate themselves in UX processes. She is drawn to her new role at Couchbase by the opportunity to work in the database space again and help scale the documentation team at a growing company. Throughout her career, Favini has found fulfillment in mentoring others and making impactful contributions through collaborative team efforts.