Welcome
API Documentation Portfolio
by Sheethal U — Technical Writer | Manual QA
Welcome to my API Documentation Portfolio.
This repository showcases a collection of well-structured, tested and developer-friendly API documentations written in Markdown.
About Me
I’m Sheethal U, a Manual QA Engineer and technical writer specializing in Manual QA, API Testing, API documentation, and developer manuals.
Portfolio Projects
Below folder contains a Markdown documentation (README.md), Test cases, Postman collection, and Postman documentation for a specific API or developer use case.
| Folder | Description |
|---|---|
| api-docs | Source directory containing endpoint specifications, error schemas, and QA validations |
| live-portal | Interactive developer portal built using MkDocs and deployed via GitHub Pages |
| postman-collections | API with login and search endpoints |
| test-cases | Test cases for Search API endpoint |
Tools & Formats
All documentation written in:
- Markdown (.md)
- REST & JSON examples
- Consistent structure: Overview → Auth → Endpoints → Errors → Examples
- Optional: Test cases, Postman collection, and Postman examples