๐Ÿ“– DocReview Studio Official Manual
๐Ÿ‡ฏ๐Ÿ‡ต ๆ—ฅๆœฌ่ชž ๐Ÿš€ Launch Web App

DocReview Studio User Manual

DocReview Studio is a 100% client-side, AI-collaborative document proofreading studio that runs completely inside your browser. It allows technical writers, reviewers, and engineering teams to load local HTML manuals or Markdown documents (.md / .markdown), record feedback visually, automatically bundle structured revision prompts for LLMs (Claude, Gemini, ChatGPT), highlight inline diffs in real time, and verify changes side-by-side with a WinMerge-style visual diff inspector.


๐Ÿ“‘ Table of Contents

1. Core Concepts & Architecture (Human-AI Review Cycle)
2. UI Layout & 3-Pane Structure
3. Quick Start (Get Started in 3 Steps)
4. Core Review Workflow (Text Highlights, Image Reviews & Evidence)
5. AI Prompt Integration (Automated LLM Revision Instructions)
6. Visual Diff Inspection (Inline Highlighting & Side-by-Side Comparison)
7. Generation & Snapshot Management (Version Checkpoints & Safe Exports)
8. Keyboard Shortcuts, Independent Zoom & Multi-Window Tools


1. Core Concepts & Architecture (Human-AI Review Cycle)

Main Workspace View

๐Ÿค– Human-in-the-Loop AI Collaboration Cycle

๐Ÿ”’ Zero Server Transmission • 100% Local Privacy

๐Ÿ“ High-Speed HTML & Markdown (.md) Rendering

๐Ÿš€ No Installer Required • Cross-Platform (Windows & macOS)


2. UI Layout & 3-Pane Structure

DocReview Studio features an ergonomically designed 3-pane workspace tailored for extended, distraction-free proofreading sessions.

Area Component Primary Functions
Header Control Bar Open source folder, workspace history, generation controls (Snapshot Save / Export As), Evidence export (JSON / MD), AI prompt copy, and WinMerge-style diff toggle.
Left Pane File Tree Hierarchical tree of HTML/Markdown documents with search filter, badge indicators (HTML / MD), and independent zoom widget.
Center Pane Preview & Diff Inspector Live HTML/Markdown document rendering, inline diff highlighting, side-by-side block diff comparison, and detached window views.
Right Pane Evidence List Card list of review feedback items with target text, line estimates, category pills, instructions, and independent zoom controls.

๐Ÿ’ก Dynamic Pane Resizing: Drag the divider lines (resizers) between panes to flexibly adjust the widths of the file tree and evidence cards to suit your display setup.


3. Quick Start (Get Started in 3 Steps)

Open Source Folder

STEP 1: Open Your Source Directory

  1. Click the "๐Ÿ“ Open Source" button in the top header.
  2. Choose the local directory containing your HTML or Markdown manuals and grant browser access when prompted.
  3. The file hierarchy will populate in the left pane (filter anytime using the search box above).
  4. If you have opened this directory previously, use the "๐Ÿ•’ History" button to restore your prior workspace state instantly.

STEP 2: Select a Document to Review (Automatic v0 Backup)

  1. Click any file in the left file tree.
  2. The document renders immediately in the center pane. At the exact moment it is opened, its pristine original state is automatically captured and safeguarded as "v0: Initial Source" in memory.
  3. This ensures that even if an AI overwrites the active file, you can always compare changes against the original benchmark without manual backups.

STEP 3: Highlight Text & Log Feedback

  1. Drag and highlight any phrase or sentence in the center preview, then click "๐Ÿ“Œ Add to Feedback".
  2. A new card is created in the right pane with auto-detected line numbers and context. Type your instruction (e.g., "Clarify benchmark numbers", "Fix typo").

4. Core Review Workflow (Text Highlights, Image Reviews & Evidence)

Text Highlighting and Evidence Input

1. Logging Feedback from Text Selection

  1. Highlight target text in the center preview with your mouse cursor.
  2. Click either the floating "๐Ÿ“Œ Add to Feedback" tooltip directly above the selection or the toolbar button "๐Ÿ“Œ Add to Feedback List".
  3. A new feedback card is appended to the right pane, and the instruction text area is automatically focused.

2. Reviewing Images & Figures (Right-Click Instant Log)

3. Document-Wide General Feedback

To provide broad guidance for an entire document (e.g., "Unify tone across all sections", "Add SEO keywords to headings"):

4. Editing Feedback Cards

Each feedback card automatically tracks and displays:

5. Exporting & Restoring Evidence

Use the Evidence action group in the header to preserve and share review results:


5. AI Prompt Integration (Automated LLM Revision Instructions)

AI Prompt Generation Modal

Transform your logged feedback into production-grade prompts formatted specifically for LLMs (Claude 3.5/3.7, Gemini 2.0/3.0, ChatGPT o3/GPT-4o) to execute direct in-place modifications accurately.

Copying Instructions to Clipboard

Example of Generated LLM Prompt

ใ€Target File: 01_intro.htmlใ€‘
Please directly edit the specified file to apply the revisions listed below.

ใ€Strict Execution Rulesใ€‘
1. Single File Scope: Do not execute web searches or search/grep other files in the project.
2. Ignore External Links: Do not validate or alter external URL links (hrefs). Strictly perform simple text replacement on the target strings.
3. Preserve Markup & Identifiers: Keep existing HTML tags, attributes, class names, code blocks, and English code identifiers intact. Do not alter surrounding text unless instructed.

========================================
[Feedback #1] ใ€Fixใ€‘
Target File: 01_intro.html (~L.18)
Target Text:
"In-Memory Full-Text Search: Loads hundreds of Excel sheets into memory and returns results instantly."
Context:
"...Key Features: In-Memory Full-Text Search: Loads hundreds of Excel sheets into memory and returns results instantly. 100% Offline Operation..."
Instruction:
Add the latest benchmark metrics (~0.8s for 100 files) to demonstrate explicit performance advantages.

6. Visual Diff Inspection (Inline Highlighting & Side-by-Side Comparison)

Visual Diff Inspector

After your AI assistant or team members complete the revisions, inspect and verify changes visually using two dedicated diff modes.

1. Real-Time Inline Diff Highlighting (Recommended)

2. WinMerge-Style Side-by-Side Block Comparison

3. High-Precision HTML Tokenizer Engine

4. ๐Ÿ”„ Instant Reload Buttons


7. Generation & Snapshot Management (Version Checkpoints & Safe Exports)

Manage progressive document milestones directly in the browser without having to switch over to Git or command line tools.

Lifecycle of Generations

  1. v0: Initial Original: The untouched baseline recorded automatically upon first opening. It remains safeguarded as the ultimate comparison benchmark.
  2. ๐Ÿ“ธ Save Snapshot: After an AI applies a batch of fixes and you verify the outcome, click "๐Ÿ“ธ Save" to commit this milestone as "v1", "v2", etc.
  3. Active Working File: The live disk file currently receiving edits.
  4. Generation Selector: Select any prior generation from the dropdown menu to dynamically change which baseline version is compared against your working files.
  5. ๐Ÿ“ฅ Export As: Export any historic snapshot safely under a distinct filename (e.g., index_v0_snapshot.html) without overwriting your original.

8. Keyboard Shortcuts, Independent Zoom & Multi-Window Tools

Sidebar Toggle and Shortcuts

โŒจ๏ธ Keyboard Shortcuts (Windows & macOS Compatible)

Action Windows macOS (Mac)
Toggle Left Pane (File Tree) Alt + 1 Option + 1 (โŒฅ1)
Toggle Right Pane (Evidence List) Alt + 2 Option + 2 (โŒฅ2)
Independent Pane Zoom Under Cursor Ctrl + Scroll Wheel
or Alt + Scroll Wheel
Cmd + Scroll (โŒ˜)
or Option + Scroll (โŒฅ)
Reset Pane Zoom to 100% Ctrl + 0
or Middle-Click / Alt + 0
Cmd + 0 (โŒ˜0)
or Middle-Click / Option + 0

๐Ÿ” Independent 3-Zone Zoom System

Each pane (File Tree, Document Preview, and Evidence Cards) features its own dedicated zoom widget (โˆ’ 100% ๏ผ‹) in its header.

๐Ÿ–ฅ๏ธ Multi-Display Detached Window Mode

โ†‘