Skip to content

Instantly share code, notes, and snippets.

@dphilla

dphilla/tech_outline_skeleton.md

Last active February 25, 2018 20:42
Show Gist options
  • Save dphilla/28957b1db7acb3340accf3a194e54cd0 to your computer and use it in GitHub Desktop.
Save dphilla/28957b1db7acb3340accf3a194e54cd0 to your computer and use it in GitHub Desktop.
Download ZIP
Technical Outline
Raw
tech_outline_skeleton.md

Outline Components

Introduction

Background of technology or service

Why the reader should be interested in this topic

Setup / Tools needed

What background can you assume of the reader

Language / Framework Versions

Dependencies

Walkthrough / Coding

Showing > Telling

LOTS of code snippets

What do you love/hate about tutorials/articles you've read when trying to learn something new?

Wrapping up / Further reading

Concluding, High-Level thoughts on topic

Further Reading (External Links)

Your info (GitHub, Twitter)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment