Documentation/Library Documentation Template

= Libraries Documentation = 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 libraries.

Who should use this template?
This template is suitable for writing any form of library documentation and shouldn't be used for anything else asides that.

= Template = Below is the provided template for this particular genre and is to be duly followed when creating documentation.

Title
The name of the library should be written boldly at the top. For this template, a title is not needed.

Getting Help
The audience needs to know where they could visit when they are stuck or have issues. You shoudl provide a link to the following;


 * FAQs
 * Librabry Index
 * Bug reporting.

The FAQ as the name implies is a page that contains a list basic questions that the audience is most likely to have with respective answers to those questions. A seperate document should be created for the FAQ, and you can use this template(Link to be added) as a starting point/guide.

The Library index is a list of all methods and APIs that this library provides. It should be added towards the end of this page and a link to it should be provided.

Libraries are bound to have bugs and this the way bugs are reported vary from library to library, you should state how bugs should be reported to your library here and provide all useful links.

The above can be structured as shown below;

Having trouble? We’d like to help!


 * Check the FAQ, it has answers to lots of common questions.
 * Looking for specific information? Check the Library Index or the detailed table of contents above.
 * Found a bug? Report bugs on our GitHub repository here.

Getting Started
This section should explain what the library does in depth, put the audience through how to install the library, and also introduce them to it's basic syntax.

What is library X
This part should answer the following questions;


 * What does this library do?
 * What problem is it trying to solve?
 * Why was it created and who was it created for?
 * Who created it and when was it created?