From 36dcfd8a2bae87e841694b89bae0ac6be3849c5f Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Wed, 29 Jan 2014 13:02:18 -0500 Subject: Use markdown for all the things --- docs/.gitignore | 2 ++ docs/Makefile | 14 ++++++++++ docs/ProductBacklog.md | 51 ++++++++++++++++++++++++++++++++++ docs/ProjectCharter.md | 26 +++++++++++++++++ docs/ProjectCharter.txt | 13 --------- docs/ProjectLeaguerWorkloadBreakup.md | 14 ++++++++++ docs/ProjectLeaguerWorkloadBreakup.txt | 14 ---------- 7 files changed, 107 insertions(+), 27 deletions(-) create mode 100644 docs/.gitignore create mode 100644 docs/Makefile create mode 100644 docs/ProductBacklog.md create mode 100644 docs/ProjectCharter.md delete mode 100644 docs/ProjectCharter.txt create mode 100644 docs/ProjectLeaguerWorkloadBreakup.md delete mode 100644 docs/ProjectLeaguerWorkloadBreakup.txt diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..f4df0be --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +*.pdf +*.html diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..277c18a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,14 @@ +docs = ProductBacklog ProjectCharter ProjectLeaguerWorkloadBreakup + +pdf: $(addsuffix .pdf,$(docs)) +html: $(addsuffix .html,$(docs)) + +%.pdf: %.md Makefile + pandoc -s $< -o $@ +%.html: %.md Makefile + pandoc -s $< -o $@ + +ProductBacklog.pdf: Diagram01.jpg + +clean: + rm -f -- *.pdf *.html diff --git a/docs/ProductBacklog.md b/docs/ProductBacklog.md new file mode 100644 index 0000000..7a2f382 --- /dev/null +++ b/docs/ProductBacklog.md @@ -0,0 +1,51 @@ +--- +title: Team 6 - Leaguer +author: [ Nathaniel Foy, Guntas Grewal, Tomer Kimia, Andrew Murrell, Luke Shumaker, Davis Webb ] +--- + +Problem Statement +----------------- + +In team-based tournament sports, often individual contributions are +overshadowed by the binary end result: win or lose. This +winner-takes-all mentality may unfairly pair players in later stages +of the tournament based on the team's score rather than their own in +early stages. + + +Background +---------- + +Generally, new team based competitions have been managed +electronically using archaic methods. The winning team advances and +the losing team is defeated. In the real world there are many +examples of individual review (as in football) and handicaps (as in +golf). Our goal is to create software that allows teams to compete +and review their peers to more accurately represent modern team +competitions. Our domain is online competition management and +e-sports. The targeted audience is defined on two levels, on a broad +level it is for any individual wishing to manage a competitive event, +on a niche level it is for individuals looking to manage and +participate in team competitions (like League of Legends). + +TODO - Luke write about existing software. + +System Model +------------ + +![](./Diagram01.jpg)\ + +Requirements +------------ + ++---------+-----------------------------+-----------------------------+ +| | Functional Requirements | Non-Functional Requirements | ++=========+=============================+=============================+ +| Must be | - foo | - baz | +| done | - bar | - quux | +| | | | ++---------+-----------------------------+-----------------------------+ +| If time | - item | - stuff | +| allows | | | +| | | | ++---------+-----------------------------+-----------------------------+ diff --git a/docs/ProjectCharter.md b/docs/ProjectCharter.md new file mode 100644 index 0000000..f88ccd4 --- /dev/null +++ b/docs/ProjectCharter.md @@ -0,0 +1,26 @@ +1. In team-based tournament sports, often individual contributions are + overshadowed by the binary end result: win or lose. This + winner-takes-all mentality may unfairly pair players in later + stages of the tournament based on the team's score rather than + their own in early stages. + +2. Project Objectives: + * To address issues of fairness in tournament orchestration and + * To create a general-purpose open source solution for organizing + team-based tournaments where individual performance matters + * by implementing an out-of-the-box open source server software + * capable of managing pairings, scoring, and statistics for a + variety of applicable game types + * accessable via an intuitive web interface. + +3. Stakeholders - the development team, testers, and a future community of users. + +4. A Project Leaguer server provides the user with everything needed + to run a tournament: regisration, pairing, scoring, and statistics, + right away through a simple web interface. Project Leaguer also + gives its users a unique option for scoring, not available through + traditional tournament management techniques: peer review. By + providing a forward facing, web-based interface for tournament + participants to score their teammates, Project Leaguer allows + individual ability and activity to be recognized within the context + of an all-in, win-or-lose multiplayer team game. diff --git a/docs/ProjectCharter.txt b/docs/ProjectCharter.txt deleted file mode 100644 index 8564884..0000000 --- a/docs/ProjectCharter.txt +++ /dev/null @@ -1,13 +0,0 @@ -1) In team-based tournament sports, often individual contributions are overshadowed by the binary end result: win or lose. This winner-takes-all mentality may unfairly pair players in later stages of the tournament based on the team's score rather than their own in early stages. - -2) Project Objectives - - *To address issues of fairness in tournament orchestration and - *To create a general-purpose open source solution for organizing team-based tournaments where individual performance matters - **by implementing an out-of-the-box open source server software - **capable of managing pairings, scoring, and statistics for a variety of applicable game types - **accessable via an intuitive web interface. - -3) Stakeholders - the development team, testers, and a future community of users. - -4) A Project Leaguer server provides the user with everything needed to run a tournament: regisration, pairing, scoring, and statistics, right away through a simple web interface. Project Leaguer also gives its users a unique option for scoring, not available through traditional tournament management techniques: peer review. By providing a forward facing, web-based interface for tournament participants to score their teammates, Project Leaguer allows individual ability and activity to be recognized within the context of an all-in, win-or-lose multiplayer team game. \ No newline at end of file diff --git a/docs/ProjectLeaguerWorkloadBreakup.md b/docs/ProjectLeaguerWorkloadBreakup.md new file mode 100644 index 0000000..99d9c2e --- /dev/null +++ b/docs/ProjectLeaguerWorkloadBreakup.md @@ -0,0 +1,14 @@ +How to break up workload: + + * Login/Registration/Verification System + * SQL Database Design and Access + * User Interface + * Officiator Interface/Admin Access + * Pairings and Statistics + * Peer Review + * Secure Saved Server Image (backed up user profiles, database, and statistics) + * Separate Game Module Plugins + * General Abstractions + * Unit Testing and Error Handling + * Installing and Running Out-of-the-box + * Icons and Images diff --git a/docs/ProjectLeaguerWorkloadBreakup.txt b/docs/ProjectLeaguerWorkloadBreakup.txt deleted file mode 100644 index 0f0e595..0000000 --- a/docs/ProjectLeaguerWorkloadBreakup.txt +++ /dev/null @@ -1,14 +0,0 @@ -How to break up workload: - - *Login/Registration/Verification System - *SQL Database Design and Access - *User Interface - *Officiator Interface/Admin Access - *Pairings and Statistics - *Peer Review - *Secure Saved Server Image (backed up user profiles, database, and statistics) - *Separate Game Module Plugins - *General Abstractions - *Unit Testing and Error Handling - *Installing and Running Out-of-the-box - *Icons and Images \ No newline at end of file -- cgit v1.2.3-2-g168b