Documentation Reading
API Documentation Reading Lab
Decode OpenAPI pages, error catalogs, and deprecation notes without losing the thread.
USD 68 informational until invoiced
Program narrative
You work through authentic excerpts from public and internal-style API references. Each module isolates a skill: scanning for constraints, mapping endpoints to outcomes, and summarizing changes between versions. Mentors model aloud in English while you annotate PDFs and HTML exports we provide.
What ships in the syllabus
- Guided passes on pagination, auth scopes, and rate-limit language
- Glossaries that contrast informal Spanish chat with formal doc tone
- Pair drills on rewriting vague sentences into testable statements
- Checklists for diffing changelog bullets before a release
- Live office hours to clarify ambiguous parameter descriptions
- Short writing tasks that mirror real ticket updates
- Peer review swap focused on clarity, not grammar policing
Outcomes you can demonstrate
- Skim a new endpoint group and list risks in under ten minutes
- Produce a plain-English summary stakeholders can act on
- Flag documentation gaps using a shared review template
Lead mentor
Mariana Ortega
Former technical writer for a fintech API; coaches doc reading in bilingual cohorts.
Cohort questions
Includes an explicit limitation on scope.
No. We use neutral REST and GraphQL samples. Familiarity with any JSON-based API helps.
Yes, for six weeks after each session. Live participation is still expected for two checkpoints.
We do not teach API design or authoring full reference sites—this course stays on reading and summarizing.
Recent participant notes
“The OpenAPI scavenger hunt finally made “nullable” vs “optional” click. I still stumble on vendor jargon, but the annotation system from week two is now my default.”
“Clear pacing, though one module packed too many edge cases in a single hour. The mentor feedback on my summary paragraphs was the strongest part.”