Project Requirements

[thuey]

Creative Writing Practice Application - Requirements Document

1. System Overview

A web-based application that helps users practice specific elements of creative writing through guided prompts and tracking capabilities.

2. Functional Requirements

2.1 Writing Element Selection

• Users can select from the following writing elements:
  • Character development
  • Dialogue
  • Setting description
  • Plot development
  • Sensory details
  • Emotional scenes
  • Action sequences

2.2 Prompt Generation

• System provides relevant writing prompts based on selected element
• Each prompt includes:
  • Main instruction/scenario
  • Suggested word count range
  • Estimated time for completion
  • Specific focus points for the chosen element

2.3 Writing Interface

• Clean, distraction-free writing space
• Real-time word count
• Timer showing elapsed writing time
• Auto-save functionality
• Option to mark writing as complete

2.4 Writing History

• Searchable archive of past writings
• Filter by:
  • Writing element
  • Date
  • Word count
  • Completion status
• Ability to edit past entries
• Export functionality for writings

2.5 Analytics Dashboard

• Writing statistics:
  • Total writing time
  • Daily/weekly/monthly word counts
  • Current streak of consecutive writing days
  • Average writing session duration
  • Most practiced elements
  • Progress towards goals
• Visual representations (graphs/charts)
• Downloadable progress reports

2.6 Goal Setting

• Users can set goals for:
  • Daily word count
  • Writing session duration
  • Writing frequency
  • Element-specific practice targets
• Progress tracking
• Goal completion notifications
• Adjustable goal parameters

3. Non-Functional Requirements

3.1 Performance

• Page load time < 2 seconds
• Real-time saving with no noticeable delay
• Support for concurrent users

3.2 Security

• Secure user authentication
• Encrypted data storage
• Regular backups of user content

3.3 Usability

• Responsive design for mobile/tablet/desktop
• Intuitive navigation
• Accessibility compliance
• Offline capability for writing interface

4. Technical Requirements

4.1 Frontend

• Modern web framework (React/Vue.js)
• Responsive CSS framework
• Rich text editor component
• Data visualization library

4.2 Backend

• RESTful API
• Database for user data and writings
• Authentication system
• Analytics processing engine

4.3 Infrastructure

• Cloud hosting
• CDN for static assets
• Database backup system
• Monitoring and logging

5. Future Enhancements

• Writing groups/communities
• Peer feedback system
• AI-powered writing analysis
• Custom prompt creation
• Writing contests/challenges
• Integration with popular writing tools

[thuey]

-- Modified schema.sql with UUIDs
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";

CREATE TABLE users (
    user_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    email VARCHAR(255) UNIQUE NOT NULL,
    password_hash VARCHAR(255) NOT NULL,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
    last_login TIMESTAMP WITH TIME ZONE
);

CREATE TABLE writing_elements (
    element_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    name VARCHAR(50) NOT NULL,
    description TEXT,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

CREATE TABLE prompts (
    prompt_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    element_id UUID REFERENCES writing_elements(element_id),
    content TEXT NOT NULL,
    suggested_word_count INTEGER,
    estimated_time_minutes INTEGER,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

CREATE TABLE writings (
    writing_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    user_id UUID REFERENCES users(user_id),
    prompt_id UUID REFERENCES prompts(prompt_id),
    element_id UUID REFERENCES writing_elements(element_id),
    content TEXT NOT NULL,
    word_count INTEGER NOT NULL,
    time_spent_seconds INTEGER NOT NULL,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

CREATE TABLE writing_stats (
    stat_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    user_id UUID REFERENCES users(user_id),
    date DATE NOT NULL,
    total_words INTEGER DEFAULT 0,
    total_time_seconds INTEGER DEFAULT 0,
    elements_practiced UUID[] DEFAULT '{}',
    UNIQUE(user_id, date)
);

CREATE TABLE goals (
    goal_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    user_id UUID REFERENCES users(user_id),
    goal_type VARCHAR(50) NOT NULL,
    target_value INTEGER NOT NULL,
    start_date DATE NOT NULL,
    end_date DATE,
    completed BOOLEAN DEFAULT FALSE,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

CREATE TABLE goal_progress (
    progress_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    goal_id UUID REFERENCES goals(goal_id),
    date DATE NOT NULL,
    current_value INTEGER NOT NULL,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
    UNIQUE(goal_id, date)
);