Saltar al contenido principal

Documentation Management Dashboard

The Documentation Management Dashboard provides administrators with a centralized interface to upload, process, and manage screen recordings that automatically generate technical documentation for the Scrollengine platform.

Overview

The Documentation Management Dashboard is part of DocuCapture, Scrollengine's automated documentation generation system. This tool allows technical writers and administrators to upload screen recordings and convert them into structured documentation pages through AI-powered analysis.

The dashboard provides real-time visibility into your documentation pipeline, including usage metrics, processing status, and completion tracking. All uploaded recordings are processed automatically and can be monitored through a comprehensive table view.

FeatureDescription
Upload InterfaceDirect file upload for screen recordings with custom titles
Usage TrackingReal-time metrics for monthly usage against plan limits
Processing StatusLive status updates for each recording's conversion progress
Content ManagementView, organize, and delete documentation recordings

Why Use the Documentation Dashboard

  • Streamline Documentation Creation — Convert screen recordings directly into structured documentation pages
  • Track Resource Usage — Monitor monthly uploads against your plan limits to optimize workflow
  • Centralize Content Management — Manage all documentation recordings from a single interface
  • Automate Processing — Eliminate manual documentation writing through AI-powered analysis
  • Maintain Quality Control — Review and organize completed documentation before publication

Accessing the Documentation Dashboard

  1. Navigate to the RAG Admin panel
  2. In the left sidebar, locate the DOCUCAPTURE section
  3. Click Recordings to access the main dashboard

Step 1

This screenshot shows the complete Documentation Management Dashboard interface, displaying the upload section, usage metrics, and recordings table.

Understanding Dashboard Components

The dashboard is organized into four main sections that provide comprehensive management capabilities:

Upload Section

The top section allows you to add new screen recordings for processing:

FieldDescription
Documentation titleCustom name for the recording that will be used in the generated documentation
Choose FileFile selector for uploading screen recording files
UploadInitiates the upload and processing workflow

Usage Metrics

Four metric cards display your current usage status:

MetricDescription
THIS MONTHNumber of recordings uploaded in the current billing period
MONTHLY LIMITMaximum recordings allowed per month on your current plan
TOTALAll-time count of uploaded recordings
COMPLETEDNumber of recordings that have finished processing

Recordings Table

The main table displays all uploaded recordings with the following columns:

ColumnDescription
TitleThe name assigned to each recording during upload
StatusCurrent processing state (completed, processing, failed)
ProgressDetailed progress indicator showing completion status
CreatedTimestamp showing when the recording was uploaded
DeleteAction link to remove recordings from the system

Uploading New Recordings

  1. In the upload section, enter a descriptive title in the Documentation title field
  2. Click Choose File to select your screen recording
  3. Select the appropriate video file from your computer
  4. Click Upload to begin processing
tip

Use clear, descriptive titles that reflect the feature or process being documented. This title will be used as the basis for the generated documentation page title.

Monitoring Processing Status

After uploading, recordings appear in the table with status indicators:

  • Green "completed" badge — Recording has been fully processed and documentation generated
  • Progress shows "Done" — All processing steps have been completed successfully
  • Timestamp — Shows when the recording was originally uploaded

Processing typically completes within minutes, depending on recording length and system load.

Managing Existing Recordings

Use the recordings table to organize and maintain your documentation library:

  1. Review the Status column to identify completed recordings
  2. Check Progress for any recordings that may have encountered issues
  3. Use the Delete action to remove outdated or incorrect recordings
  4. Sort by Created timestamp to find recent uploads
precaución

Deleting a recording permanently removes it from the system and cannot be undone. Ensure you no longer need the recording before deletion.

Best Practices

  • Use descriptive titles that clearly indicate the feature or process being documented
  • Monitor your monthly usage to stay within plan limits and avoid processing delays
  • Review completed recordings promptly to ensure quality and accuracy
  • Delete outdated recordings to keep your dashboard organized and maintain storage efficiency
  • Upload recordings during off-peak hours for faster processing times

Troubleshooting

IssueSolution
Upload failsVerify file format is supported and file size is within limits
Recording stuck in processingWait 10-15 minutes, then contact support if status doesn't update
Dashboard not loadingClear browser cache and refresh, or try a different browser
Delete action not workingEnsure you have admin permissions and the recording is not currently processing
Usage metrics not updatingMetrics refresh every few minutes; wait briefly and reload the page