Technical writing portfolio — REST API documentation sample.
View the Project on GitHub yadhukrish/api-documentation-sample
A technical writing portfolio sample demonstrating RESTful API documentation, structured reference writing, and docs-as-code practices.
This repository documents the OpenWeather Current Weather API. It is written for developers who need to retrieve real-time weather data by city name, ZIP code, or geographic coordinates.
Documentation type: API Reference + Quickstart
Audience: Developers integrating weather data into applications
Writing style: Google Developer Documentation Style Guide
Tooling: Markdown, GitHub, Postman, cURL
| Document | Description |
|---|---|
| Quickstart | Get a live weather response in under 5 minutes |
| Authentication | How to generate and use your API key |
| Request Parameters | Full parameter reference with types and constraints |
| Response Schema | JSON structure and field definitions |
| Error Reference | HTTP status codes and resolution steps |
Yadhukrishnan PV is a Technical Writer with a background in QA engineering, bringing 5+ years of combined experience to API documentation and developer-facing content.