MovaBase Documentation Plan

This document outlines the complete structure for MovaBase user documentation, covering all features and UX elements for developers and non-developers.

Documentation Structure

1. Getting Started ✅

1.1 Welcome to MovaBase ✅

• What is MovaBase and who is it for
• Key benefits and use cases
• Overview of the main interface NEEDS_MEDIA
• Navigation basics
• Account and organization concepts

1.2 Creating Your Account ✅

• Sign up process
• Email verification
• Setting up your profile
• Understanding your workspace NEEDS_MEDIA

1.3 Creating Your First Organization ✅

• Organization overview
• Creating an organization NEEDS_MEDIA
• Organization settings
• Team collaboration basics

1.4 Creating Your First Project ✅

• Project concept and purpose
• Creating a new project NEEDS_MEDIA
• Project settings and configuration
• Understanding project download modes

2. Core Concepts ✅

2.1 Projects and Organizations ✅

• Relationship between organizations and projects ✅
• When to use multiple organizations ✅
• When to use multiple projects ✅
• Project visibility and access ✅ NEEDS_MEDIA

2.2 Languages and Translations ✅

• Language structure in MovaBase ✅
• Translation keys and values ✅
• Default language concept ✅
• Supported language formats ✅ NEEDS_MEDIA

2.3 Download Modes ✅

• File-based mode explained ✅
• Language-based mode explained ✅
• When to use each mode ✅
• Download mode comparison ✅ NEEDS_MEDIA

2.4 Files and Organization ✅

• File-based organization structure ✅
• Language-based organization structure ✅
• Key naming conventions ✅
• Best practices for file organization ✅ NEEDS_MEDIA
• File-based organization structure ✅
• Language-based organization structure
• Key naming conventions
• Best practices for file organization NEEDS_MEDIA

3. Project Management ✅

3.1 Project Dashboard ✅

• Overview of project interface ✅
• Navigation tabs (Translations, Info, Settings) ✅
• Project statistics and metrics ✅ NEEDS_MEDIA

3.2 Project Settings ✅

• Project information (name, description, emoji) ✅
• Download mode configuration ✅
• Project linking setup ✅
• Deleting or archiving projects ✅ NEEDS_MEDIA

3.3 Project Linking ✅

• What is project linking ✅
• Benefits of linked projects ✅
• Setting up project links ✅
• Managing linked languages ✅ NEEDS_MEDIA

4. Language Management ✅

4.1 Adding Languages ✅

• Adding standard languages ✅ NEEDS_MEDIA
• Adding custom languages ✅
• Setting default language ✅
• Language ordering and organization ✅

4.2 Managing Languages ✅

• Editing language properties ✅
• Removing languages ✅
• Language visibility controls ✅
• Show/hide languages feature ✅ NEEDS_MEDIA

4.3 Available Languages ✅

• Supported language list ✅
• Custom language creation ✅
• Language codes and names ✅

3.4 Project Info Panel

• Viewing project details
• Understanding project metadata
• Export format information NEEDS_MEDIA

4. Language Management

4.1 Adding Languages

• Adding standard languages NEEDS_MEDIA
• Adding custom languages
• Setting default language
• Language ordering and organization

4.2 Managing Languages

• Editing language properties
• Removing languages
• Language visibility controls
• Show/hide languages feature NEEDS_MEDIA

4.3 Available Languages

• Supported language list
• Custom language creation
• Language codes and names
• Language emoji selection NEEDS_MEDIA

5. Translation Management

5.1 Translation Interface Overview ✅

• Translation table layout ✅
• Key navigation ✅
• Language columns ✅
• Real-time collaboration indicators ✅

5.2 Viewing Translations ✅

• Scanning through translations ✅
• Understanding translation rows ✅
• Key visualization ✅
• Value display ✅ NEEDS_MEDIA

5.3 Editing Translations ✅

• Click to edit functionality ✅
• Editing translation values ✅
• Saving changes automatically ✅
• Edit mode indicators ✅ NEEDS_MEDIA

5.4 Adding New Translations ✅

• Creating new translation keys ✅
• Adding translations for multiple languages ✅
• Key naming best practices ✅
• Bulk translation entry ✅ NEEDS_MEDIA

5.5 Deleting Translations ✅

• Single translation deletion ✅
• Deleting translation keys ✅
• Translation trash feature ✅
• Restoring deleted translations ✅ NEEDS_MEDIA

6. File Management

6.1 File-Based Mode

• File structure overview
• Creating new files NEEDS_MEDIA
• Editing file names
• Deleting files
• File organization tips

6.2 Language-Based Mode

• Language folder structure
• File behavior in language mode
• Export structure differences NEEDS_MEDIA

6.3 File Operations

• Upload translation files
• Download translation files
• Supported file formats
• File format selection dialog NEEDS_MEDIA

7. Download and Export

7.1 Download Overview

• Download button location
• Download format dialog NEEDS_MEDIA
• Available export formats
• Download mode effects

7.2 Export Formats

• JSON format for Web
• .strings format for iOS
• .xml format for Android
• PO format for translations NEEDS_MEDIA

7.3 Download Process

• Selecting export format
• Downloading as ZIP
• File structure in ZIP
• Extracting and using downloads NEEDS_MEDIA

8. File Upload and Import

8.1 Upload Overview

• Upload button location
• Upload dialog interface NEEDS_MEDIA
• File selection process

8.2 Upload Process

• Selecting file format
• Choosing target language
• Upload progress and confirmation
• Merging with existing translations NEEDS_MEDIA

8.3 Upload Best Practices

• File preparation tips
• Handling conflicts
• Language mapping
• Large file handling NEEDS_MEDIA

9. Search and Filter

9.1 Search Translations

• Search bar location
• Searching by key
• Searching by value NEEDS_MEDIA
• Search results display

9.2 Filter Options

• Filter by language
• Filter by file
• Filter by key pattern
• Combining filters NEEDS_MEDIA

9.3 Advanced Search

• Using wildcards
• Exact match search
• Case sensitivity
• Quick navigation NEEDS_MEDIA

10. Tree View and Navigation

10.1 Tree View Overview

• Hierarchical key display
• Expand and collapse functionality
• Key visualization in tree structure NEEDS_MEDIA

10.2 Tree Navigation

• Browsing translation keys
• Finding specific keys
• Key relationships
• File organization in tree view NEEDS_MEDIA

10.3 Key Collapsing

• Collapsing individual keys
• Collapsing sections
• Managing view complexity
• Keyboard shortcuts NEEDS_MEDIA

11. Bulk Operations

11.1 Selection Overview

• Selecting translations
• Selection checkboxes NEEDS_MEDIA
• Select by language
• Select by file

11.2 Bulk Actions

• Bulk delete
• Bulk edit preparation
• Selection count display
• Confirming bulk operations NEEDS_MEDIA

11.3 Advanced Selection

• Select all in view
• Invert selection
• Clear selection
• Selection shortcuts NEEDS_MEDIA

12. Translation History

12.1 Viewing History

• History button location
• Opening translation history NEEDS_MEDIA
• Understanding history timeline
• Change details display

12.2 History Features

• Viewing past versions
• Comparing changes
• Who made changes
• When changes occurred NEEDS_MEDIA

12.3 Restoring Translations

• Reverting to previous versions
• Undo functionality
• Version management
• History retention NEEDS_MEDIA

13. Real-Time Collaboration

13.1 Presence Indicators

• User presence display
• Understanding user cursors NEEDS_MEDIA
• Multiple user indicators
• User identification

13.2 Typing Indicators

• Seeing who is typing
• Typing location display
• Conflict prevention
• Real-time updates NEEDS_MEDIA

13.3 Collaboration Tips

• Working with teams
• Avoiding conflicts
• Communication best practices
• Synchronous editing NEEDS_MEDIA

14. Bitbucket Integration

14.1 Integration Overview

• What is Bitbucket integration
• Benefits of integration
• Integration setup requirements
• Workflow overview NEEDS_MEDIA

14.2 Connecting Bitbucket

• OAuth authentication process
• Granting permissions
• Selecting workspace and repository
• Connection confirmation NEEDS_MEDIA

14.3 Repository Configuration

• Selecting branch
• Setting base path
• Choosing file format
• Pull request settings NEEDS_MEDIA

14.4 Syncing Translations

• Manual sync process
• Sync progress display
• Understanding sync results
• Conflict handling NEEDS_MEDIA

14.5 Pull Requests

• Creating pull requests
• PR title and description
• Reviewing PR content
• PR management NEEDS_MEDIA

14.6 Sync Settings

• Auto-sync options
• Sync frequency
• Format preferences
• Disconnecting Bitbucket NEEDS_MEDIA

15. API Keys

15.1 API Keys Overview

• What are API keys used for
• When to use API keys
• Security considerations
• Key permissions NEEDS_MEDIA

15.2 Creating API Keys

• Creating a new key
• Naming your key
• Key creation process NEEDS_MEDIA
• Saving your key

15.3 Managing Keys

• Viewing existing keys
• Key usage statistics
• Last used information
• Key expiration NEEDS_MEDIA

15.4 Revoking Keys

• Deleting API keys
• Security best practices
• Rotation procedures
• Revocation confirmation NEEDS_MEDIA

16. Organization Management

16.1 Organization Dashboard

• Overview of organization interface
• Project list display
• Organization statistics NEEDS_MEDIA
• Quick actions

16.2 Organization Settings

• Organization details
• Member management
• Billing information
• Organization preferences NEEDS_MEDIA

16.3 Team Management

• Adding team members
• Member roles and permissions
• Inviting new users
• Member list management NEEDS_MEDIA

17. User Roles and Permissions

17.1 Role Overview

• Owner role
• Admin role
• Developer role
• Viewer role NEEDS_MEDIA

17.2 Permission Matrix

• Create projects
• Edit translations
• Manage languages
• Manage files
• Delete projects
• Invite users NEEDS_MEDIA

17.3 Role Assignment

• Assigning roles
• Changing roles
• Role limitations
• Role inheritance NEEDS_MEDIA

18. Profile and Account

18.1 User Profile

• Profile overview
• Editing profile information
• Email management
• Account settings NEEDS_MEDIA

18.2 Security Settings

• Password management
• Two-factor authentication
• Session management
• Account security NEEDS_MEDIA

18.3 Preferences

• Interface preferences
• Notification settings
• Language preferences
• Theme options NEEDS_MEDIA

19. Troubleshooting

19.1 Common Issues

• Translation not saving
• File upload errors
• Download problems
• Sync issues NEEDS_MEDIA

19.2 Performance Issues

• Slow loading times
• Large project handling
• Browser compatibility
• Network problems NEEDS_MEDIA

19.3 Account Issues

• Login problems
• Access denied
• Role permissions
• Billing issues NEEDS_MEDIA

20. Best Practices

20.1 Project Organization

• Structuring projects
• Naming conventions
• File organization tips
• Project size management NEEDS_MEDIA

20.2 Translation Workflow

• Translation process
• Quality assurance
• Review workflow
• Deployment preparation NEEDS_MEDIA

20.3 Team Collaboration

• Team setup
• Work allocation
• Review process
• Communication tips NEEDS_MEDIA

20.4 Integration Workflows

• Bitbucket workflow
• CI/CD integration
• API usage patterns
• Automation strategies NEEDS_MEDIA

Appendix

A. Keyboard Shortcuts

• Navigation shortcuts
• Editing shortcuts
• Selection shortcuts
• Action shortcuts NEEDS_MEDIA

B. Supported File Formats

• Format specifications
• Format examples
• Conversion guidelines
• Format limitations NEEDS_MEDIA

C. FAQ

• Frequently asked questions
• Common use cases
• Tips and tricks
• Additional resources NEEDS_MEDIA