mirror of
https://github.com/documenso/documenso.git
synced 2026-07-26 09:54:51 +10:00
feat: docs v2 (#2460)
Co-authored-by: Catalin Pit <catalinpit@gmail.com>
This commit is contained in:
Lucas Smith
GitHub
@@ -0,0 +1,215 @@
|
||||
---
|
||||
title: Create Templates
|
||||
description: Build reusable document templates for contracts, agreements, and other documents you send frequently.
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
|
||||
## Overview
|
||||
|
||||
Templates are reusable document configurations that save you from recreating the same setup every time you send a similar document. A template stores your PDF, recipient roles, field placements, and settings so you can generate new documents with a few clicks.
|
||||
|
||||
Use templates when you:
|
||||
|
||||
- Send the same type of document regularly (contracts, NDAs, onboarding forms)
|
||||
- Need consistent field placement across documents
|
||||
- Want to pre-configure recipients and signing workflows
|
||||
- Plan to use [direct links](/docs/users/documents/direct-links) for public signing
|
||||
|
||||
## Create a Template from Scratch
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
### Go to templates
|
||||
|
||||
Navigate to **Templates** in the sidebar and click **Upload Template**.
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Upload your document
|
||||
|
||||
Select one or more PDF files to upload. If you select multiple files, they're combined into a single template.
|
||||
|
||||
After uploading, you'll enter the template editor where you can configure recipients, fields, and settings.
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Add recipients
|
||||
|
||||
Add the people who will interact with documents created from this template. For each recipient, specify:
|
||||
|
||||
- **Email**: Use a real email if the recipient is always the same person, or a placeholder email (like `client@placeholder.com`) if it changes each time
|
||||
- **Name**: Optional, but helps identify recipients
|
||||
- **Role**: What the recipient needs to do (Signer, Approver, Viewer, CC)
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Add fields
|
||||
|
||||
Drag fields from the field palette onto your document and assign them to recipients. At minimum, each signer needs one signature field.
|
||||
|
||||
See [Add Fields](/docs/users/documents/add-fields) for detailed guidance on field types and configuration.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Save the template
|
||||
|
||||
Click **Save Template** to finish. Your template appears in the Templates list, ready to use.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
---
|
||||
|
||||
## Placeholder Recipients
|
||||
|
||||
Templates often need placeholder recipients - people whose actual email addresses you won't know until you use the template. For example, a sales contract template might have:
|
||||
|
||||
- **You** (your real email) - Always signs as the company representative
|
||||
- **Client** (placeholder) - Different person for each contract
|
||||
|
||||
### Setting up placeholders
|
||||
|
||||
Use any email format that's clearly a placeholder:
|
||||
|
||||
- `client@placeholder.com`
|
||||
- `signer1@example.com`
|
||||
- `recipient@documenso.com`
|
||||
|
||||
When you [use the template](/docs/users/templates/use), you'll replace these placeholders with actual recipient emails.
|
||||
|
||||
### When to use real emails
|
||||
|
||||
Use real email addresses when the recipient is always the same person:
|
||||
|
||||
- Your own email for documents you always sign
|
||||
- A team member who reviews all contracts
|
||||
- A compliance officer who needs to approve every agreement
|
||||
|
||||
---
|
||||
|
||||
## Template Settings
|
||||
|
||||
Click the settings icon in the template editor to configure these options:
|
||||
|
||||
### Title
|
||||
|
||||
The template name shown in your Templates list. Use a descriptive name like "Standard NDA" or "Freelance Contract - Hourly" so you can find it quickly.
|
||||
|
||||
The title also becomes the default document name when you create documents from the template. Recipients see this name in their signing invitation.
|
||||
|
||||
### External ID
|
||||
|
||||
An optional identifier for integrating with external systems. Use this to:
|
||||
|
||||
- Match templates to records in your CRM or contract management system
|
||||
- Track which template generated a document in your analytics
|
||||
- Reference templates in API calls
|
||||
|
||||
The external ID has no effect on document signing - it's purely for your reference.
|
||||
|
||||
### Global settings
|
||||
|
||||
Additional options that apply to all documents created from this template:
|
||||
|
||||
| Setting | Description |
|
||||
| ------------ | ---------------------------------------------------------------- |
|
||||
| Date format | How dates appear in Date fields (e.g., MM/DD/YYYY or DD/MM/YYYY) |
|
||||
| Time zone | Time zone used for date calculations |
|
||||
| Redirect URL | Where to send recipients after they finish signing |
|
||||
| Language | Language for the signing interface and emails |
|
||||
|
||||
---
|
||||
|
||||
## Template Visibility
|
||||
|
||||
All templates are created in a team context. Team members can see, edit, delete, and use the templates in that team. See [Organisations](/docs/users/organisations) to learn about creating and managing organisations.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Template
|
||||
|
||||
To modify an existing template:
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
Go to **Templates** and find the template you want to edit.
|
||||
</Step>
|
||||
<Step>
|
||||
Click on the template to open it in the editor.
|
||||
</Step>
|
||||
<Step>
|
||||
Make your changes to recipients, fields, or settings.
|
||||
</Step>
|
||||
<Step>
|
||||
Click **Save Template**.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
Changes only affect future documents created from the template. Documents already created from this template are not updated.
|
||||
|
||||
---
|
||||
|
||||
## Duplicate a Template
|
||||
|
||||
To create a copy of an existing template:
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
Go to **Templates** and find the template.
|
||||
</Step>
|
||||
<Step>
|
||||
Click the three-dot menu and select **Duplicate**.
|
||||
</Step>
|
||||
<Step>
|
||||
The copy opens in the editor; make any changes and save with a new name.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
This is useful when you need a variation of an existing template without modifying the original.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Template
|
||||
|
||||
To delete a template:
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
Go to **Templates** and find the template.
|
||||
</Step>
|
||||
<Step>
|
||||
Click the three-dot menu and select **Delete**.
|
||||
</Step>
|
||||
<Step>
|
||||
Confirm the deletion.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Callout type="warn">
|
||||
Deleting a template is permanent. Documents already created from the template are not affected,
|
||||
but you won't be able to create new documents from it.
|
||||
</Callout>
|
||||
|
||||
---
|
||||
|
||||
## See Also
|
||||
|
||||
- [Use a Template](/docs/users/templates/use) - Create documents from your template
|
||||
- [Direct Links](/docs/users/documents/direct-links) - Share a signing link without knowing recipient emails
|
||||
- [API: Templates](/docs/developers/api/templates) - Create and use templates programmatically
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Templates
|
||||
description: Create reusable document templates for common signing workflows.
|
||||
---
|
||||
|
||||
## Why Use Templates?
|
||||
|
||||
- **Save time**: Don't recreate the same document structure repeatedly
|
||||
- **Consistency**: Ensure fields are placed correctly every time
|
||||
- **Efficiency**: Pre-configure recipients and settings
|
||||
|
||||
---
|
||||
|
||||
## Template Workflow
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="Create a Template"
|
||||
description="Build a reusable template from a document."
|
||||
href="/docs/users/templates/create"
|
||||
/>
|
||||
<Card
|
||||
title="Use a Template"
|
||||
description="Create documents from your templates."
|
||||
href="/docs/users/templates/use"
|
||||
/>
|
||||
</Cards>
|
||||
|
||||
---
|
||||
|
||||
## See Also
|
||||
|
||||
- [Documents](/docs/users/documents) - Sending individual documents
|
||||
- [API Templates](/docs/developers/api/templates) - Create templates via API
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"title": "Templates",
|
||||
"pages": ["create", "use"]
|
||||
}
|
||||
@@ -0,0 +1,147 @@
|
||||
---
|
||||
title: Use Templates
|
||||
description: Create documents from your templates by filling in recipient details and optionally sending immediately.
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
|
||||
|
||||
## Create a Document from a Template
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
### Open the template
|
||||
|
||||
Navigate to **Templates** in the sidebar and find the template you want to use. Click on the template to open its detail page, or click the three-dot menu and select **Use Template**.
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Click use template
|
||||
|
||||
From the template detail page, click the **Use Template** button. A dialog opens where you configure the document.
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Fill in recipient details
|
||||
|
||||
For each recipient defined in the template, enter their:
|
||||
|
||||
- **Email** (required): The recipient's email address
|
||||
- **Name** (optional): The recipient's display name
|
||||
|
||||
If the template has pre-filled recipient information, those fields appear with the existing values. You can modify them or leave them as-is.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### Choose how to create the document
|
||||
|
||||
<Tabs items={['Create as draft', 'Create and send']}>
|
||||
<Tab value="Create as draft">
|
||||
|
||||
Creates the document without sending. You can review and edit it before sending. Leave the **Send document** checkbox unchecked.
|
||||
|
||||
</Tab>
|
||||
<Tab value="Create and send">
|
||||
|
||||
Creates the document and immediately sends it to recipients. Check the **Send document** checkbox to send immediately.
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
### New document
|
||||
|
||||
Click **Create as draft** or **Create and send** depending on what you want to do. You are then redirected to the new document.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Upload a Custom Document
|
||||
|
||||
You can replace the template's PDF with a different document when creating from a template. This keeps all the field positions and recipient settings but uses your uploaded file.
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
In the Use Template dialog, check **Upload custom document**.
|
||||
</Step>
|
||||
<Step>
|
||||
Click **Upload** next to each document you want to replace and select a PDF from your computer.
|
||||
</Step>
|
||||
<Step>
|
||||
Complete the rest of the form and create the document.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Callout type="info">
|
||||
The uploaded document must be a PDF. Field positions are preserved from the template, so the new
|
||||
document should have a similar layout.
|
||||
</Callout>
|
||||
|
||||
## Sequential Signing
|
||||
|
||||
If the template uses sequential signing, recipients receive the document in order. The signing order displays next to each recipient in the dialog and cannot be changed when using the template.
|
||||
|
||||
To modify the signing order, edit the template itself before creating documents from it.
|
||||
|
||||
## Distribution Methods
|
||||
|
||||
How recipients receive the document depends on the template's distribution method:
|
||||
|
||||
| Distribution method | What happens |
|
||||
| ------------------- | ----------------------------------------------------------- |
|
||||
| **Email** | Recipients receive an email with a link to sign |
|
||||
| **None** | No emails sent. You receive signing links to share manually |
|
||||
|
||||
When using a template with no email distribution and selecting **Create as pending**, you're redirected to the document page where signing links are displayed for you to copy and share.
|
||||
|
||||
## Template vs Document Differences
|
||||
|
||||
When you create a document from a template, the document becomes independent. Changes you make to the document don't affect the template, and changes to the template don't affect existing documents.
|
||||
|
||||
| What you can change | Template | Document created from template |
|
||||
| ------------------- | -------- | -------------------------------- |
|
||||
| Recipients | Yes | Yes (before sending) |
|
||||
| Fields | Yes | Yes (before sending) |
|
||||
| PDF content | Yes | Only at creation (custom upload) |
|
||||
| Settings | Yes | Yes (before sending) |
|
||||
|
||||
Documents created from a template are tracked on the template's detail page under **Documents created from template**.
|
||||
|
||||
## Bulk Send
|
||||
|
||||
To create multiple documents from one template with different recipients, use bulk send:
|
||||
|
||||
{/* prettier-ignore */}
|
||||
<Steps>
|
||||
<Step>
|
||||
Go to the template detail page or templates list.
|
||||
</Step>
|
||||
<Step>
|
||||
Click the three-dot menu and select **Bulk send**.
|
||||
</Step>
|
||||
<Step>
|
||||
Upload a CSV file with recipient information. Each row creates a separate document.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
This is useful for sending the same document to many people, such as offer letters or agreements.
|
||||
|
||||
---
|
||||
|
||||
## See Also
|
||||
|
||||
- [Create a Template](/docs/users/templates/create) - Build reusable templates from your documents
|
||||
- [Direct Links](/docs/users/documents/direct-links) - Let recipients sign without knowing their email upfront
|
||||
- [Send Documents](/docs/users/documents/send) - Sending options and email customization
|
||||
Reference in New Issue
Block a user