Skip to content

Latest commit

 

History

History
132 lines (69 loc) · 3.39 KB

docs-template.md

File metadata and controls

132 lines (69 loc) · 3.39 KB

Introduction

I'm new to this tool and I've just 2 minutes to grasp the basic idea. Help me out!

Overview

What does this tool do and why it exists? (Not how it works!)

This tool was created to... The primary job for this tool is to... With this tool you can easily...

Use cases

What is the typical use case?

The basic use case for this tool is... Usually this tool serves as a... This tool is used at...

Where and when should I use this tool?

You can use this tool to build... This tool best works for...

Is it for me?

How hard is it to use this tool?

To use this tool you need to have basic knowledge about... This tool is easy to use for...

When should I never use this tool?

This tool will not perform well for X, you should use Y instead... If you just want to..., you'd rather use Z.

Are there any limitations of this tool?

Currently this tool won't work for... Keep in mind that this tool is meant to... and not to...

What are the alternatives?

If you want to X, the better way is to use...

Quick start

I got the basic idea. Now I need to see this tool in action!

Follow these steps to quickly start using this tool...

Is there anything I need to do, before I start using this tool?

To start off with this tool, follow these steps:

  • prepare a valid...
  • create an account...
  • run the init...

OK, I've prepared the workspace. What do I need to do, to see it running?

There is a ready-to-use example... To see the online demo... Do X to see it working...

Recipies (optional)

Now, once I saw it in action, I want to see more.

To better understand the power of this tool, check out following guides. To explore all of the functionalites, go to the API reference...

Guide on creating...

...

Using this tool to...

...

Guide on preparing...

...

API reference (optional)

I'm here every day for the last week. Just let me know what this method does.

Methods, Callbacks, Objects definitions

I expect here to see the full technical index of all methods, callbacks and objects.

Advanced usage (optional)

I've already worked with this tool. I've mastered its basic use case. I want more.

Advanced example

What are the most advanced / complex / hard use cases of this tool?

Although this tool is dedicated to... we've seen people successfully using it to... To find out the advanced use cases, check this guides below.

Guide on building your own...

...

Creating X from the ground up...

...

How it works

How this tool works internally? Can I modify or extend this tools' functionalities?

If you want to tailor this tool for your very specific use case...

Help

I still have some questions. I've scrolled here impatiently. Where should I go, what should I do?

FAQ

I'm about to ask a really popular question. I want the answer now!

Q: Is that a really short and simple question?

Yes, it is! Those questions are the best – easy to skim and digest.

Feedback

I hate love this tool! Where can I leave some feedback?

The best way to leave the feedback is... We're always open for changes... Let us know if...

Contributing

How can I help to improve this tool?

If you want to help us out...

Changelog

I'm really curious when this was changed?