Join us in San Francisco on the 29/30th of October for two days of developer workshops and technical talks

Structure Overview

This document provides a guide for how documentation is structured in Nexmo Developer.

How should I structure documents?

Nexmo Developer content should be designed to be clear, concise and consistent in that order.

Exceptions can be made to break consistency where it makes sense, particularly in scenarios where the content would be unnecessarily verbose or the structures outlined in this guide are unsuited to the material.

#{alt_text}

Structure

Nexmo Developer is structured by context and by product. The four main sections of Nexmo Developer are:

Documentation

This section hosts the bulk of the written content for the NDP. The content is structured by products each of which have the following four sections:

API Reference

API Reference pages document the following properties of the API:

SDKs and Tools

A section that outlines our SDKs, Tools, Libraries etc. The repository README should provide all necessary information.

Community

As it develops, the community section will be a repository for 'cool hacks', open source projects that use Nexmo, the events that Nexmo will attend or sponsor, and blog posts that the community has written about Nexmo.