API Documentation Intensive

Cover image for API Documentation Intensive

4 weeks · Workshop · Advanced · Weekends

API Documentation Intensive

₩420,000 informational

Hands-on intensive for engineers and writers who maintain public or internal APIs. Practice OpenAPI alignment, auth flows, and error message tables with realistic payloads from sample services.

Included

  • — OpenAPI schema walkthroughs
  • — Tutorial vs reference separation drills
  • — Error catalog workshop
  • — Authentication flow narrative templates
  • — Versioning and deprecation copy patterns
  • — Peer review on two endpoint groups

Outcomes

  • → Complete reference section for a sample API
  • → Write a getting-started tutorial with tested steps
  • → Document breaking-change communication
Jae Won Kim

Jae Won Kim

API platform writer; contributed to developer portals used by 40k+ monthly readers.

FAQ

Which tools are covered?

We use Stoplight, Redocly-style previews, and plain Markdown repos. Tool licenses are not included.

Can teams enroll together?

Yes — up to five seats per cohort share a private review channel.

Limitations?

We do not cover gRPC/protobuf doc generators in depth; focus is REST and OpenAPI 3.x.

Reviews

"Finally understood how to split tutorial content from auto-generated reference. The auth-flow template saved our onboarding page rewrite."
— Elena V., Backend engineer
Request information