SCRIPT_DOCUMENTATION_TEMPLATE.md

[Script Name]

Overview

[Brief description of what the script does and its primary purpose]

Current Version: v[X.X.X]

Type

• Indicator
• Strategy
• Study

Features

• Feature 1: [Description]
• Feature 2: [Description]
• Feature 3: [Description]

Parameters

[Parameter Group 1]

• Parameter Name: Description (default: [value])
• Parameter Name: Description (default: [value])

[Parameter Group 2]

• Parameter Name: Description (default: [value])
• Parameter Name: Description (default: [value])

How It Works

1. [Step 1 description]
2. [Step 2 description]
3. [Step 3 description]

Visual Elements (For Indicators)

• [Color/Shape]: [What it represents]
• [Color/Shape]: [What it represents]

Risk Management (For Strategies)

• Target: [Description]
• Stop Loss: [Description]
• Position Sizing: [Description]
• Max Trades: [Description]

Backtest Configuration (For Strategies)

• Initial Capital: $[amount]
• Commission: $[amount] per contract/trade
• Slippage: [amount] points/ticks
• Position Size: [description]

Best Use Cases

• [Use case 1]
• [Use case 2]
• [Use case 3]

Alerts (If Applicable)

• Alert Name: [Description of trigger condition]
• Alert Name: [Description of trigger condition]

Known Limitations

• [Limitation 1]
• [Limitation 2]

Version History

See archive/ folder for historical versions with detailed change logs.

Performance Notes (For Strategies)

• Best Markets: [Description]
• Struggles With: [Description]
• Recommended Timeframe: [Description]

Usage

1. Copy the .pine file contents to TradingView Pine Editor
2. Apply to [recommended symbol/timeframe]
3. Adjust parameters based on [market conditions/objectives]
4. [Additional setup steps if needed]

Dependencies

• External data source (specify symbol: e.g., NYSE:TICK)
• Specific timeframe required
• Other requirements

Last Updated

[YYYY-MM-DD]

---

Notes for Developers

[Any technical notes, gotchas, or important implementation details]