Skip to content

Project Plans and References

This page provides links to various planning documents and technical references for the Metricis project.

Active Plans

Current planning documents for ongoing features:

Architecture Documents

Technical design documents:

Completed Plans

Historical planning documents (archived):

Located in docs/archive/completed-plans/:

  • Amendment SOP - Standard operating procedure for protocol amendments
  • Comprehensive Study Management - Study lifecycle management
  • EDC Implementation - Electronic data capture features
  • RBAC Implementation - Role-based access control
  • Sidebar Menu - Portal navigation design
  • SurveyJS Integration - Form builder integration
  • UI Plans - Various UI component implementations

PROMIS Documentation

PROMIS assessment implementation:

Located in docs/archive/promis/:

  • PROMIS Overview - Patient-reported outcomes measurement
  • PROMIS Bundles - Neurology-specific item banks
  • PROMIS Implementation - Technical implementation details

Project Plans

Strategic planning documents:

Located in docs/project-plan/:

Mobile Deployment

Mobile platform documentation:

UI Reference

Interface documentation:

Historical Context

NIH Toolbox

Early assessment options considered:

Located in docs/archive/:

  • NIH Toolbox Overview - NIH assessment suite
  • NIH Toolbox Gaps - Limitations for our use case
  • TMB Testset - Test method battery

Cognitive Test Reviews

Assessment evaluations:

Located in docs/archive/planning/:

  • Cognitive Test Review - Evaluation of available tests
  • Tiered Design - Two-tier assessment approach

Technology Evaluations

Framework comparisons:

Located in docs/archive/planning/:

  • SurveyJS vs REDCap Comparison - Form builder evaluation
  • REDCap System Structure - REDCap integration analysis

Contributing

When creating new planning documents:

  1. Place in appropriate directory:
  2. Active plans → docs/plans/
  3. Architecture → docs/architecture/
  4. Project strategy → docs/project-plan/

  5. Completed → docs/archive/completed-plans/

  6. Use markdown format with clear headings and structure

  7. Include metadata at the top: 

    # Document Title
**Status:** Draft | In Progress | Complete | Archived
**Created:** YYYY-MM-DD
**Updated:** YYYY-MM-DD
**Author:** Name

  8. Link to related documents for context

  9. Update this index when adding new documents

Document Templates

Planning Document Template

# Feature Name

**Status:** Draft
**Created:** 2026-01-24
**Updated:** 2026-01-24
**Author:** Development Team

## Overview

Brief description of the feature or change.

## Goals

- Goal 1
- Goal 2
- Goal 3

## Requirements

### Functional Requirements

- FR1: Description
- FR2: Description

### Non-Functional Requirements

- NFR1: Description
- NFR2: Description

## Architecture

Describe the technical approach.

## Implementation Plan

1. Step 1
2. Step 2
3. Step 3

## Testing

Describe testing approach.

## Deployment

Describe deployment process.

## Timeline

Estimated timeline and milestones.

## Dependencies

List any dependencies or prerequisites.

## Risks and Mitigation

Identify potential risks and mitigation strategies.

Next Steps