A personal knowledge base for learning and practicing API documentation, maintained in Obsidian and version-controlled with GitHub.
I'm building this notebook as I develop my technical knowledge of REST APIs, HTTP, developer tools, and API documentation practices.
It brings together explanations, command references, practical examples, troubleshooting notes, and lessons learned through hands-on experimentation.
My goal is to create a reference I can return to whenever I need to refresh my understanding of a concept, remember how to use a tool, or work through a documentation task.
Rather than reproduce tutorials or official documentation, I aim to explain concepts in my own words and connect what I'm learning to the practical work of technical writing.
The notebook is organized into four main categories:
| Folder | Contents |
|---|---|
| Concepts | Foundational topics such as HTTP, request and response headers, authentication, and status codes. |
| Tools | Notes and command references for tools such as cURL, HTTPie, and Postman. |
| Documentation | API documentation conventions, techniques, formats, and workflows. |
| Troubleshooting | Errors, unexpected behavior, investigations, and solutions encountered while learning. |
The repository also includes a style guide that establishes conventions for clarity, consistency, and usability across the notes.
I maintain the notes in Obsidian, using Markdown and internal links to connect related topics.
As I work through tutorials, experiment with APIs, and practice writing documentation, I add information that I want to understand more deeply or reference later.
I prioritize:
- Clear explanations that make sense without revisiting the original learning material.
- Practical examples that demonstrate how concepts and tools work.
- Accurate information supported by documentation or hands-on verification.
- Consistent formatting and organization that make notes easy to navigate.
- Useful connections between related concepts.
This is an evolving collection of personal learning notes, not a comprehensive API documentation manual.
Some topics are more developed than others, and notes may change as I gain experience or discover updated information.
Examples may be illustrative or specific to the tools and environments in which I tested them. For authoritative specifications and current tool behavior, consult the relevant official documentation.