Skip to main content
Version: Isle Royale (2.5.0)

Managing Documents & Versions

Documents are the foundation of your ToughClicks integration. Each document represents a legal agreement template (like Terms of Service or Privacy Policy) that evolves over time through versions.

Accessing Documents​

To manage your documents, navigate to https://app.toughclicks.com/document in the Management Portal.

From this page, you can:

  • View all your documents
  • Create new documents
  • Edit document metadata
  • Manage document versions

Understanding Documents vs Versions​

It's important to understand the distinction between documents and versions:

  • Document: A container for a type of legal agreement that holds metadata like the display name
  • Version: A specific instance of the document's terms, numbered and timestamped

Example: You might have a "Terms of Service" document with multiple versions:

  • Version 1.0 (published Jan 2024)
  • Version 1.1 (published Mar 2024)
  • Version 2.0 (published Jun 2024)

Each version contains different terms, and users must accept the latest version to be considered compliant.

Creating a New Document​

  1. Click Create Document in the documents page
  2. Enter a display name (e.g., "Terms of Service", "Privacy Policy")
  3. Optionally add a description for internal reference
  4. Click Save

Your new document is created in draft state, ready for you to add terms.

Managing Document Versions​

Viewing All Versions​

  1. Click on any document row in the documents table
  2. This opens the document details page
  3. Here you'll see all versions of this document's terms, listed chronologically

Creating a New Version (Draft)​

  1. From the document details page, click Update Terms
  2. Enter the new legal content for this version
  3. The version is automatically saved as a DRAFT
  4. Drafts can be edited and refined before publishing
Content Editing

You can use rich text formatting in your terms. The editor supports:

  • Headers and text formatting
  • Links and lists
  • Custom HTML if needed

Publishing a Version​

When your draft is ready to go live:

  1. Review the draft content carefully
  2. Click Publish Version
  3. Confirm the publish action
Important - Published Versions are Immutable

Once a version is published, it will be live immediately and cannot be edited or deleted. This ensures the integrity of user acceptances and maintains a legally sound audit trail.

To make changes, you must create a new version.

Version States​

Versions can be in one of two states:

StateDescriptionCan Edit?Visible to Users?
DRAFTWork in progress, not yet liveYesNo
PUBLISHEDLive and activeNoYes

Version Numbering​

ToughClicks uses semantic versioning for documents:

  • Major.Minor format (e.g., 1.0, 1.1, 2.0)
  • Major version changes (1.x → 2.x) indicate significant updates
  • Minor version changes (1.0 → 1.1) indicate smaller modifications
  • The system automatically increments version numbers when you publish

Best Practices​

Document Organization​

  • Use clear, descriptive names for documents
  • Keep related terms in separate documents (ToS, Privacy, etc.)
  • Use consistent naming conventions across your organization

Version Management​

  • Always review drafts thoroughly before publishing
  • Document what changed between versions (use descriptions)
  • Notify users when major version updates occur
  • Keep a changelog of version updates for internal reference

Content Guidelines​

  • Write clear, understandable terms
  • Use proper legal language where required
  • Include effective dates in the content
  • Link to related documents when appropriate

Common Workflows​

  1. Identify the document that needs updating
  2. Click Update Terms to create a new draft version
  3. Make the necessary legal changes
  4. Have your legal team review the draft
  5. Publish the new version
  6. Users will automatically be prompted to accept the new version

Seasonal or Temporary Terms​

  1. Create a new version with temporary terms
  2. Publish when needed
  3. When the period ends, create another version reverting to standard terms
  4. All version history is preserved

Multi-Language Support​

  1. Create separate documents for each language
  2. Use naming like "Terms of Service (English)" and "Terms of Service (Spanish)"
  3. Organize them into appropriate packets
  4. Direct users to the correct language packet

Troubleshooting​

I accidentally published the wrong version​

Published versions cannot be unpublished or deleted. Create a new corrected version immediately and publish it. The new version will become active for all future acceptances.

Users aren't seeing the new version​

  • Check that the version is published (not in draft state)
  • Verify the version is included in your active packet
  • Clear any caching if applicable
  • Check the integration code is requesting the correct packet

How do I delete a document?​

Documents with published versions cannot be deleted to maintain audit integrity. You can:

  • Mark the document as inactive in the description
  • Remove it from all active packets
  • Set an expiration date if needed

Next Steps​