https://github.com/chop-dbhi/eig_project_template

This is a template for README markdown file on every eig projects and code repos and relate them to public DBHi projects (can be used here or in enterprise github)
https://github.com/chop-dbhi/eig_project_template

documentation project-management project-template

Last synced: about 1 month ago
JSON representation

This is a template for README markdown file on every eig projects and code repos and relate them to public DBHi projects (can be used here or in enterprise github)

• Host: GitHub
• URL: https://github.com/chop-dbhi/eig_project_template
• Owner: chop-dbhi
• Created: 2018-07-11T11:38:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-11T12:01:21.000Z (over 6 years ago)
• Last Synced: 2024-11-07T23:33:30.508Z (3 months ago)
• Topics: documentation, project-management, project-template
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


> Written with [StackEdit](https://stackedit.io/).

# Documenting EiG Projects 

> Brief Description (Introduction):

> This document provides a shell as to the documentation of a general project that must be completed as the project is in its intital, integration and phased implementation. THis document is a template and shell to what is expected to be documented in the project

> - Please use the README.md file on the front of the repository for this purpose. 

> - Use other files in the repo as necessary if there are document based deliverables.

> - Can be public or enterprise

> - use this README on all projects, even code.

> Mark issues in project or code repositories with the label `1:1` For items you want to discuss during your 1:1s.

# Background

# Methods

# Intended Results

## Phase 1

- Element of Phase 1

- Element of Phase 1

- [...]

## Phase 2

- Element of Phase 2

> Description of phase if necessary or not yet determined

[...]

## Phase _N_

## Associated Github Projects

### Main Project(s)

[Reference Github Projects (i.e. Arcus POC](https://github.research.chop.edu)

### Dependencies

> Reference dependent repos or issues unresolved

 - [ ] List item

 - [ ] [Reference Dependent Repos or Issues](https://www.github.com)

 - [x] Comp  

[Reference resolved github repos or issues](https://github.com)

### Immediate Issues 

> to discuss in 1:1s or generally

|Item|Issue  |

|--|--|

| This thing doesn’t work | [33](https://github.com) |

| This is so cool | [122](https://github.com)|

## Collaborators

**Non-DBHi**

:Adam Resnick

:Bill Gaynor

:Bob Baldsanno

:Steve Hungar

DBHi

[Alex Felmeister](https://github.com/AlexFelmeister)