Code Monkey home page Code Monkey logo

data-engineering-project-doc-templates's Introduction

Data Engineering Project Documentation Templates

This repository is used to provide guidance in a standard data engineering project that consists of a data lake and data warehouse. The documentation originated out of a need to standardize a requirements gathering methodology. It is derived from the CRISP-DM (Cross Industry Standard Process for Data Mining).

Usage

There are nine templates numbered in logical order within the templates directory. These templates have text in italics that is used for reference purposes. You may clone, modify, or fork the repository at your leisure.

Note that some documentation processes may overlap as you learn more about your project. Do not feel obligated to fill everything out in sequence. Generally you will fill out the first few documents in order and adjust as needed. For more details, learn about CRISP-DM.

Contributing

My goal in publishing these templates is to make it teach others how to formalize a process around data engineering. It would be awesome for the community to expand on some of the templates to make them more featureful.

To contribute, fork this repository and open a pull request with your changes.

data-engineering-project-doc-templates's People

Contributors

tylerwmarrs avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.