Best Practices For Revision Tasks

The application includes an enhanced revision system that automatically reviews documents instead of full document rewrites. This allows for precise, targeted changes while preserving document structure and formatting.

1.0 How Revisions Work


  1. Surgical Edits: The revision agent analyzes your specific instructions and generates precise JSON patches
  2. DOM Operations: Supports operations like text replacement, style changes, class modifications, and element positioning
  3. Validation: All changes are validated to ensure they don't break document structure
  4. User Instructions Priority: Your specific revision instructions take precedence over previous terminology decisions

2.0 Effective Revision Prompts

To get the best results from the revision system, follow these guidelines when writing revision instructions:


Specific Text Changes:

"Change 'Universidad Nacional' to 'National University' throughout the document"
"Replace 'Certificado de Nacimiento' with 'Birth Certificate'"
"Update the date format from DD/MM/YYYY to MM/DD/YYYY"

Style and Formatting:

"Make all headers use Arial font instead of Times New Roman"
"Change the signature section background color to light gray"
"Increase the font size of the document title to 18px"
"Move the stamp 20px to the right and 10px down"

Layout Adjustments:

"Move the signature section below the main content"
"Add 15px margin to the left side of all paragraphs"
"Center align the document title"
"Reduce the spacing between the header and body text"

Content Corrections:

"Fix the translation of 'Fecha de Nacimiento' to 'Date of Birth' (currently shows 'Birth Date')"
"Correct the spelling of 'Certificate' (currently shows 'Certificat')"
"Update the address format to match US standards"

3.0 Approaches to Avoid

These attempts will lead to multiple efforts and time spend on task.


Vague Instructions:

"Make it better" 
"Improve the translation" 
"Fix the formatting"

Multiple Unrelated Changes:

"Change the font, fix the date, move the signature, and update the title"

Contradictory Instructions:

"Make it more formal but also more casual"

4.0 Advanced Revision Techniques

For more complex document formats:


Global Changes

For changes that should apply across the entire document:

"Use consistent font family 'Arial' for all text elements"
"Apply the same color scheme throughout the document"
"Standardize all date formats to MM/DD/YYYY"

Element-Specific Changes

For targeting specific elements:

"Change the color of all headers (h1, h2, h3) to dark blue"
"Make the signature section more prominent with a border"
"Update the footer text to include the current year"

Positioning and Layout

For spatial adjustments:

"Move the stamp to the bottom-right corner with 20px margins"
"Add padding around the main content area"
"Ensure the signature doesn't overlap with other text"