Writing Templates Guide

A comprehensive guide to crafting professional documents and templates in API Sign using Markdown syntax.

Markdown Basics

API Sign templates use Markdown, a lightweight formatting syntax that's easy to learn and produces clean, professional documents.

Headings

Use # symbols to create headings. More # symbols mean smaller headings:

# Main Title (H1)
## Section Heading (H2)
### Subsection (H3)
#### Minor Heading (H4)

Text Formatting

**Bold text** for emphasis
*Italic text* for subtle emphasis
***Bold and italic*** for strong emphasis
~~Strikethrough~~ for deleted content

Lists

Unordered lists use -, *, or +:

- First item
- Second item
  - Nested item
  - Another nested item
- Third item

Ordered lists use numbers:

1. First step
2. Second step
3. Third step

Links

[Link text](https://example.com)

Horizontal Rules

Use three or more dashes, asterisks, or underscores to create a horizontal line:

---

Template Variables

Variables are placeholders that get replaced with actual values when creating a contract from your template.

Basic Syntax

Wrap variable names in double curly braces:

{{variable_name}}

Naming Conventions

Use descriptive, lowercase names with underscores:

  • {{client_name}} - The client's full name
  • {{contract_date}} - Date of the contract
  • {{total_amount}} - Total payment amount
  • {{company_address}} - Company street address

Common Variables

VariableDescriptionExample Value
{{client_name}}Client's full nameJohn Smith
{{client_email}}Client's email addressjohn@example.com
{{company_name}}Your company nameAcme Corp
{{contract_date}}Date of the agreementJanuary 15, 2025
{{effective_date}}When the contract takes effectFebruary 1, 2025
{{expiration_date}}When the contract expiresJanuary 31, 2026
{{total_amount}}Total contract value$10,000.00
{{payment_terms}}Payment scheduleNet 30

Variable Types

When configuring your template, you can specify how each variable should be completed:

Creator-filled variables - Values you provide when creating a contract:

  • Client names and contact information
  • Dates and deadlines
  • Amounts and quantities
  • Custom terms

Signer-filled variables - Values the signer provides when signing:

  • Signatures
  • Initials
  • Date signed
  • Additional information they need to provide

Document Structure

Contract Header

Start with clear identification:

# Service Agreement

**Agreement Number:** {{agreement_number}}
**Date:** {{contract_date}}

---

Parties Section

Clearly identify all parties involved:

## Parties

This Agreement is entered into between:

**Service Provider:**
{{provider_name}}
{{provider_address}}
{{provider_email}}

**Client:**
{{client_name}}
{{client_address}}
{{client_email}}

Terms and Conditions

Use numbered sections for legal clarity:

## Terms and Conditions

### 1. Services

The Service Provider agrees to provide the following services:

{{service_description}}

### 2. Compensation

The Client agrees to pay {{total_amount}} according to the following schedule:

{{payment_schedule}}

### 3. Term

This Agreement shall commence on {{effective_date}} and continue until {{expiration_date}}.

Signature Block

End with a clear signature section:

---

## Signatures

By signing below, both parties agree to the terms and conditions outlined in this Agreement.

**Service Provider:**

Signature: {{provider_signature}}
Name: {{provider_name}}
Date: {{provider_sign_date}}

**Client:**

Signature: {{client_signature}}
Name: {{client_name}}
Date: {{client_sign_date}}

Field Types

Signature Fields

For electronic signatures, use descriptive variable names:

{{signature}}
{{client_signature}}
{{provider_signature}}

Configure these as Signature type in the Variables tab.

Initials Fields

For initials on specific clauses:

Initials: {{client_initials}}

Configure as Initials type.

Text Fields

For signer-provided text information:

Title: {{signer_title}}
Company: {{signer_company}}

Date Fields

For dates the signer provides:

Date Signed: {{date_signed}}

Best Practices

Keep It Clear

  • Use plain language when possible
  • Define technical terms
  • Break long paragraphs into shorter ones
  • Use headings to organize content

Be Consistent

  • Use the same formatting throughout
  • Keep variable naming conventions consistent
  • Maintain consistent spacing and structure

Test Your Template

  1. Create a test contract from your template
  2. Fill in all variables with sample data
  3. Preview the rendered document
  4. Check that all formatting looks correct
  5. Verify signature fields are properly placed

Legal Considerations

  • Include all necessary legal disclaimers
  • Clearly state governing law and jurisdiction
  • Define dispute resolution procedures
  • Include severability clauses

Example Templates

Simple Service Agreement

# Service Agreement

This Service Agreement ("Agreement") is entered into as of {{contract_date}}.

## Parties

**Provider:** {{provider_name}}
**Client:** {{client_name}}

## Services

Provider agrees to perform the following services:

{{service_description}}

## Compensation

Client agrees to pay Provider {{total_amount}} for the services described above.

## Term

This Agreement begins on {{start_date}} and ends on {{end_date}}.

## Signatures

**Provider:**
{{provider_signature}}
Date: {{provider_sign_date}}

**Client:**
{{client_signature}}
Date: {{client_sign_date}}

Non-Disclosure Agreement (NDA)

# Non-Disclosure Agreement

This Non-Disclosure Agreement is entered into by and between:

**Disclosing Party:** {{disclosing_party}}
**Receiving Party:** {{receiving_party}}

**Effective Date:** {{effective_date}}

## 1. Definition of Confidential Information

"Confidential Information" means any information disclosed by the Disclosing Party that is marked as confidential or that reasonably should be understood to be confidential.

## 2. Obligations

The Receiving Party agrees to:

- Hold all Confidential Information in strict confidence
- Not disclose Confidential Information to any third parties
- Use Confidential Information only for {{permitted_purpose}}

## 3. Term

This Agreement shall remain in effect for {{term_length}} from the Effective Date.

## 4. Signatures

**Disclosing Party:**
{{disclosing_signature}}
Name: {{disclosing_name}}
Date: {{disclosing_sign_date}}

**Receiving Party:**
{{receiving_signature}}
Name: {{receiving_name}}
Date: {{receiving_sign_date}}

Related Documentation