🛠 This page is currently undergoing maintenance. We apologize for any inconvenience caused. The content will be made available soon. Thank you for your patience.

Putting out fires with docs since…

Conceptual Material Consists of…

• Typically
  • Overview
  • Getting Started
  • Tutorials
  • Sample Code

Overview

• Explain why to use the API
• Requirements
• Key concepts
• Workflow
• Architecture diagrams and/or data model

Getting Started

• Lead people through a simple task
• Web APIs
  • Registration
  • Get an app key
  • Authorization
  • Doing something simple
• Platform APIs
  • Downloading the SDK
  • Setting up your IDE (integrated development environment)
  • Doing something simple

Tutorials

• Common tasks
• Set-by-step instructions
• Screenshots, if they make sense
• Start with basic tasks, move to advanced

Sample Code

• Short, simple programs that work
• Developers like to be able to copy and modify them
• Common tasks
• Well-commented
• Sample code is different than production code

Back