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
- Click Create Document in the documents page
- Enter a display name (e.g., "Terms of Service", "Privacy Policy")
- Optionally add a description for internal reference
- Click Save
Your new document is created in draft state, ready for you to add terms.
Managing Document Versions
Viewing All Versions
- Click on any document row in the documents table
- This opens the document details page
- Here you'll see all versions of this document's terms, listed chronologically
Creating a New Version (Draft)
- From the document details page, click Update Terms
- Enter the new legal content for this version
- The version is automatically saved as a DRAFT
- Drafts can be edited and refined before publishing
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:
- Review the draft content carefully
- Click Publish Version
- Confirm the publish action
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:
| State | Description | Can Edit? | Visible to Users? |
|---|---|---|---|
| DRAFT | Work in progress, not yet live | Yes | No |
| PUBLISHED | Live and active | No | Yes |
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
Updating Terms for Legal Compliance
- Identify the document that needs updating
- Click Update Terms to create a new draft version
- Make the necessary legal changes
- Have your legal team review the draft
- Publish the new version
- Users will automatically be prompted to accept the new version
Seasonal or Temporary Terms
- Create a new version with temporary terms
- Publish when needed
- When the period ends, create another version reverting to standard terms
- All version history is preserved
Multi-Language Support
- Create separate documents for each language
- Use naming like "Terms of Service (English)" and "Terms of Service (Spanish)"
- Organize them into appropriate packets
- 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