Skip to content

Instantly share code, notes, and snippets.

@hunterowens
Last active December 21, 2015 02:29
Show Gist options
  • Save hunterowens/6235144 to your computer and use it in GitHub Desktop.
Save hunterowens/6235144 to your computer and use it in GitHub Desktop.
Wiki Guide

REQUIRED WIKI SECTIONS

  • Homepage

    Intro: have a sentence or two about the project: the problems its solving, the partner, and how you're solving it. Also say that "this wiki is the central place to learn about the social problem we worked on, the data we used, the methods we used to solve it, and our findings" so people know what they're looking at. List of pages in the wiki

  • Problem

    An in-depth description of the problem your organization, the problem you're trying to solve, and any relevant domain knowledge. Feel free to copy from blog posts and posters, if relevant.

  • Data

    Describe the dataset(s) you used in the project as well as your database. Walk people through the data model (tables are handy for this), and include a (fake) sample of each dataset. If you scraped data, this is the place to document that.

  • Methodology

    An in-depth, technical write up of the method(s) you used on your projects. Use latex equation, walk people through algorithms and models, link out to relevant documentation when possible.

  • Results

    Discuss what metrics you're using to evaluate performance (if applicable), and what your final findings where.

  • Future work

    Discuss what you would like to do / what is in progress.

OPTIONAL WIKI SECTIONS - if its fits your project

  • Analysis

If you did exploratory data analysis, this is the place to put it and explain your findings. Explain each finding and what your learned from it / how it motivated the methods you used. Put this between the "Data" and "Methodology" sections. Feel free to lift content from relevant blog posts, if any.

  • Resources

Resources for domain knowledge, methods, and tech. Whatever pieces of paper you used to learn what you know.

  • Tool
    • API Documentation
    • Web app Documenation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment