Read me here
title: PM - README - Create Basic README labels:
- project-setup
A well-structured README.md
file at the root of the project repository serves as the primary source of information about the project and should be re-visited regularly.
If any of the sections cannot be completed, then the incomplete sections should be broken out into separate stories before the end of Inception.
Note: the Project Brief and Project Setup sections will be filled in via separate stories.
Given a new project with a Github repo set up
- When I look at the root of the project
- Then I find a
README.md
file
Build Status | |
---|---|
Staging | [![Build Status](fill me in) |
Production | [![Build Status](fill me in) |
Note: The CI badge links in markdown format are located in each TravisCI project by just clicking on the Badge next to the project name
- Product Owner:
- Project Start Date:
- Project Duration:
- Current End of Contract Date:
Thing | Location |
---|---|
Board | link |
Google Drive | link |
Sprint Reports | link |
Core Loop Models | link |
Continuous Integration | link |
Style Guide | link |
Staging | link |
Production | link |
iOS App Store | link |
Google Play Store | link |
brief overview
OS | Browsers |
---|---|
Windows | Chrome (latest), Firefox (latest), Edge (latest) |
Mac | Chrome (latest), Firefox (latest), Safari (latest) |
iOS | Safari (latest) |
Android | Chrome (latest) |
Platform | OS Version | Install Base |
---|---|---|
iOS | 10 and above | https://developer.apple.com/support/app-store/ |
Android | 4.4 (KitKat) and above | https://developer.android.com/about/dashboards/index.html |
Platform | Devices |
---|---|
iOS | iPhone 6 and newer |
Android | Samsung S6, S7, and S8 families |
Will be completed with Product Owner / Product Manager - Project Brief - Summarize the Product Idea
issue.
Will be completed with Product Owner / Product Manager - Project Brief - Know the User
issue.
Will be completed with Product Owner / Product Manager - Project Brief - Define the Problem
issue.
Will be completed with Product Owner / Product Manager - Project Brief - First Draft of Core Loop Model
issue.
Will be completed with Product Manager - README - First Draft of Nouns and Verbs
issue.
Role | Person | |
---|---|---|
Client | ||
Product Owner | ||
PM | ||
Tech Lead | ||
Engineer | ||
Designer | ||
QA | ||
Business Analyst | ||
Account Manager |
rationale on tech stack and architecture decision(s)
Will be completed with Lead Engineer - Product Planning - Platform / Stack Decisions
issue.