Skip to content

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)

Notifications You must be signed in to change notification settings

chop-dbhi/eig_project_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 

Repository files navigation

Written with StackEdit.

Documenting EiG Projects <title>

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

Dependencies

Reference dependent repos or issues unresolved

Reference resolved github repos or issues

Immediate Issues

to discuss in 1:1s or generally

Item Issue
This thing doesn’t work 33
This is so cool 122

Collaborators

Non-DBHi :Adam Resnick :Bill Gaynor :Bob Baldsanno :Steve Hungar

DBHi Alex Felmeister

About

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)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published