User:Gbahdeyboh/GSoD20 API AND SDK Documentation

API Documentation, SDK (Software Development Kit)

This document provides a simple template that can be used as a starting point for technical documentation that is intended to guide the audience through the use of Software Development Kits and APIs.

SDKs and APIs are synonymous, in fact, there is a distinct difference between an SDK and an API, so both cannot fit into the same genre, therefore, this document would be sub-divided into two genres.

Software Development Kit

An SDK is a suite of tools that include a range of things like libraries, documentation, APIs, code samples, etc which enables developers to integrate and build apps for specific platforms or software. The genre template for writing SDK documentation can be found here.

APIs

An API is a set of protocols and tools that aid communication between several components of a software(s). There are different types of APIs, but this genre would majorly focus on REST APIs as it is the most common to WMF projects. The genre template for writing API documentation can be found here.