Skip to content

Instantly share code, notes, and snippets.

@alextanhongpin

alextanhongpin/README.md

Created August 29, 2017 05:49
Show Gist options
  • Save alextanhongpin/8ac41ddc8adfe0878f89c03dbe61d784 to your computer and use it in GitHub Desktop.
Save alextanhongpin/8ac41ddc8adfe0878f89c03dbe61d784 to your computer and use it in GitHub Desktop.
Download ZIP
A simple guide on how to write technical articles
Raw
README.md

Objective

What do you want to achieve from this example?

Audience

Who is the target audience that is most likely interested with this example? Beginners/intermediate? Frontend/backend/devops/qas?

References

  • Where to get the source file (Github/Bitbucket etc links)

Highlights

  • What you will be going through
  • What you will learn from the example

TL;DR;

  • A short description of the setup, input and output.

Guide

  • Installation
  • Setup
  • Run
  • Output
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment