Guides and tutorials for Tech Writers
Authoring documentation, beyond editing API definition files, involves many skills and practices. Discover some of those.
Git Workflows for API Technical Writers
Explore the challenges and solutions of keeping your docs in sync with an evolving API design using git workflows.
The Role of Technical Writer in API Documentation
Explore the new role of technical writers, the skills they need to participate in writing API documentation, and the challenges they may encounter as they collaborate with development teams.
Using README-style API Documentation to Enhance Your API Design
Take a user-centric approach to API documentation by leveraging README-style documentation to bridge the gap between individual operations and practical usage scenarios.
Improving Schema Component Documentation in OpenAPI Documents
Tips and examples on how to effectively document schema components in OpenAPI specification documents.
Enriching Your OpenAPI Info Documentation for Understanding
The importance of a well-crafted OpenAPI info section, including the name, description, and tag description fields.
5 Improvements to OpenAPI Operation Documentation
A look at five operation-specific improvements that you can make to deliver on a great developer experience while reducing the support costs of your API.
API Documentation Checklist
A checklist to help you identify the documentation you will need for launching your API.
The Elements of Great API Documentation
Let’s explore the different types of API documentation and the role each has to play in helping a developer become proficient in consuming your API.
Efficient Technical Writing Processes for API Documentation
How can engineering and technical writing teams worth together on creating fantastic API documentation without stepping on each others toes?
Primitive Concepts of Git
You will learn enough of Git to decide whether you want Git in your toolbox, or perhaps why others in a collaborative project insist on using Git.