railpad Lifecycle Architecture Overview

Skit!

Scenario: Lon & Brian  Lon and Brian are software developers in a successful technology company.  Their manager makes them write extensive collaborative documents for all of the projects that they work on.  They hate writing. Fortunately for them, they have Railpad.  Rather than spending all of their time ing word documents back and forth, they use Railpad to write it.  With Railpad at the core, all of their content is in one central location that they can both access at the same time.  In addition, all of their revisions that they make along the way are logged, just in case they want to go back to something they had before.  Railpad also gives them the ability to comment on each other’s work as they write a new document, and although Lon and Brian don’t necessarily like it, their boss can comment too.  Overall, Lon and Brian end up with professional and complete documents with a minimal amount of overhead.

What is Railpad?  Web-based, collaborative text editor based upon the Wiki model.  Railpad differs from a Wiki in the breadth and power of tools it offers users.  Intuitive document editor allows: Presenting Editing Commenting Tracking revisions  Rich text editor

Flowchart

How will we build it?  Ruby on Rails  Apache  MySQL  AJAX  Rails Modules

Team Structure  Model/Control Group Tim Prouty, Brian Steadman  View Group Omar Ghishan, Dana Fujimoto, Lon Smith, Kevin Chiu  Project Manager Taj Campbell  Lead Architect Brian Steadman  Lead Designers Lon Smith, Omar Ghishan  Lead Tester Dana Fujimoto  Source Manager Kevin Chiu

Timeline

Risk Assessment  Scheduling & Team Collaboration  Revision Log Complexity  Privacy & Security  User Interface Organization  Data Loss/Corruption

Testing Methodology  Ruby classes must be accompanied by a test case when submitted to the source repository.  Each test case will be added to a system-wide functionality test suite.  The test suite will be run on a daily schedule.

Developer Environment  Ruby on Rails  RDoc & Rake  RadRails  SourceForge

Documentation  Administrator Guide Installation instructions Maintenance instructions Backend functionality guide  User Guide Comprehensive user guide FAQ  Additional Documentation Screencasts (video tutorials) Quick usage guides

Questions?