LuaGuard

Revision History:

Date	Author	Description
4-21-2014	D. O'Connor	Initial creation
4-30-2014	D.O'Connor	Update Sprint 2 Design Doc
5-17-2014	P. Govyadinov	Updated SRS. Updated User Manual. Added Progress report as of 5/14/14 Added Architecture Documentation in the software architecture page. Minor edits to pages.
5-30-14	P. Govyadinov	Updated Architecture.

1. Purpose and Audience

The intended document audience: University of Oregon team members, PKU team members, instructors, and customer,
Purpose: Identify individual responsibilities, processes, resources, and timeline so team members understand who owns a task, how its to be complete, and when it is to be delivered.

2. Team Roles and Responsibilities

Role	Team members taking on the role		Artifacts for which the role is responsible
Role	PKU	UO	Artifacts for which the role is responsible
Requirements Analyst (1)		Dennis	ConOps, Software Requirements
Architect (1)		Pavel	Module, uses, and process structures, interface specifications
Developer (>1)		Nels, Juston, Will, Pavel, Dennis, Cory Tommy	Module implementation
Tester & Integrator (>1)		Nels, Juston, Will, Pavel, Dennis, Cory Tommy	Module tests, System generation and verification plan, test results report
Project Manager and Liaison (1)		Dennis	Communication, project plan, project measures, retrospective report
Configuration Control (build master)		Will	Configuration management policy (coordinate policy with distributed teams, ensure build works). Coordinate changes to Assembla pages.
Documentation		Tommy	Installation guide and user guide

3. Risks and Risk Mitigation

Risk	Description	Mitigation
Remote development team	Project to be completed by two team in different countries	Organize work so each team has a complete module to work on that only requires a detailed interface.
Misunderstandings	Each team has a different native language	Use detailed architecture and ConOps documents to ensure each team understands roles and responsibilities
Schedule slip	An unforeseen issue or project complexity that extends the development effort beyond plan	Using a modular design to ensure that only minor functionality may be dropped due to schedule concerns.

4. Project Background

This project came from our partners in China. There is a company in China that would like the ability to obfuscate their Lua source code to make it harder for outsiders to understand.

5. Process

UO's team has decided to use Scrum as our planning and tracking methodology. To that end we have adopted VersionOne as our project planning and tracking tool. Each member of the team has an account in VersionOne so they can view the overall project status as well as update their individual progress. Our feature or story backlog is maintained in VersionOne.

6. Mechanisms, methods, techniques

We have made the following decisions to use:

Luaparse is our selection for a parser
JSON to hold our AST for passing between modules
Scrum is our project planning and tracking methodology (Sprints are 2 weeks in duration)
qq as our primary communication method with our partners in China
Java and Javascript as our languages of choice
Assembla as document and source code
VersionOne as our planning and tracking tool
Friday standup meetings for US team
Saturday meetings with China team
Saturday Sprint Planning meetings prior to each sprint

7. UO Detailed schedule and milestones

Sprint1 ends 4/25, Deliverables: parsers, ConOps Doc, Design Doc, Assembla setup, VersionOne setup, test code repository, deliver sample AST to partners in China
Sprint2 ends 5/9, Deliverables: AST Walker, Test Harness, unParser, GUI
Sprint3 ends 5/23, Deliverables: TBD
Sprint4 ends 6/6, Deliverables: TBD

UO's goal is to deliver parsing technology, testing harness for individual modules and complete system, GUI, command line.

8. PKU Detailed schedule and milestones

Schedule: tbd

PKU's goal is to deliver obfuscation modules, per module test cases. PKU's to provide timeline and deliverables for obfuscation.

9. Resources and References

www.imqq.com (location of qq application used by the team in the US)

https://www9.v1host.com/UniversityofOregon (url for VersionOne login)

www.versionone.com (main site for information about VersionOne)

oxyc.github.io/luaparse (url for location of source and documentation for luaparse)

https://www.assembla.com/spaces/uopku-dsd14s-p2/start (login location for Assembla team site)

www.assembla.com ( url for more information on what Assembla is and how to use Assembla)