API documentation

Overview
moltin offers cutting edge eCommerce microservices to its users, including inventory
management, cart, checkout, payment aggregation and more. As an API platform the
documentation is one of the most important parts of our product.

With the launch of the next major version around the corner, we’re looking to revamp our entire documentation offering. This includes a total rebuild of the documentation platform (handled in-house), as well as a full rewrite and update to the documentation itself.

The documentation is aimed at helping developers get to grips with our APIs as quickly as possible. It should be consistent and intuitive throughout while being clear and concise in a friendly tone.

Details
There will be a mix of technical writing to describe the required actions, content writing to add colour to the process being addressed, and basic use of cURL to provide examples which will later be expanded upon into various high-level programming languages.

There’s a very strict timeframe to deliver this brief, to make it happen we are looking to work with a number of freelancers and will be assigning individual sections to each. We are open to working with collectives of multiple freelancers if they are able to work to this deadline.

Some good examples of what we’re looking to achieve:

● https://stripe.com/docs
● https://goshippo.com/docs
● https://www.contentful.com/developers/docs /
● https://sendgrid.com/docs/API_Reference/SMTP_API/index.html
● https://www.algolia.com/doc/guides/getting-started/how-it-works/

Requirements
To deliver this project, you will be required to have good experience at the following:
● Writing technical documentation or articles for developer tools
● Native language must be English
● Use of markdown
● Understanding of APIs and REST
● Experience with terminal and using cURL is not required, but a plus

What We’ll Provide
To help you succeed with this project we’ll be giving you:
● A detailed roadmap of the sections, pages, and content to be written for each page
● Additional code samples to be included for each section
● Access to a moltin store and engineering to ask questions

Initially, we require you to do the attached small brief to get a sense of your technical writing style and tone and have applied the budget for this. From this, we will assess whether the style is correct for other sections of the documentation and can negotiate a budget for other sections of work. Please see the attached task as being part of the overall recruitment process.