Section outline

• Select section Day 1: Introduction to APIs and Technical Writing Best Practices (7 hours)

  Day 1: Introduction to APIs and Technical Writing Best Practices (7 hours)

  Collapse all Expand all

  Module 1: Introduction to APIs (1 hour)

  • API types (REST, SOAP, GraphQL)
  • Components: Endpoints, Methods, Parameters

  Module 2: Overview of JSON and XML (1.5 hours)

  • JSON: Syntax, structure, and nested objects
  • XML: Syntax, tags, attributes, and hierarchy

  Module 3: Technical Writing Best Practices (1.5 hours)

  • Writing structured and audience-focused documentation
  • Documenting code samples and edge cases

  Module 4: Hands-on Practice: Writing JSON and XML (2 hours)

  • Writing API requests and responses in JSON
  • Documenting XML structures

  Module 5: Tools for API Documentation (1 hour)

  • Overview of tools: Swagger, Postman, Stoplight
  • Auto-generating and versioning API documentation
• Select section Day 2: Documenting API Requests, Responses, and Error Handling (7 hours)

  Day 2: Documenting API Requests, Responses, and Error Handling (7 hours)

  Module 6: Documenting API Requests and Responses (2 hours)

  • Methods: GET, POST, PUT, DELETE
  • Hands-on: Documenting a sample API in JSON

  Module 7: Documenting API Errors (1.5 hours)

  • Common error codes (4xx, 5xx)
  • Hands-on: Documenting error messages

  Module 8: Real-world Case Study: API Documentation (1.5 hours)

  • Analyzing major platforms (e.g., Google, Stripe)
  • Best practices and critiques

  Module 9: Creating API Reference Guides (1.5 hours)

  • Writing API reference documents with examples
  • Hands-on: Create an API reference guide

  Module 10: Final Project and Review (1.5 hours)

  • Documenting a full API (requests, responses, errors)
  • Peer review and feedback
• Select section Assessment

  Assessment

  • Assignments during modules
  • Final project documenting an API with JSON and XML