Script Documentation Template

General Information

• Script Name:
• Script Version:
• Author:
• Creation Date:
• Last Modified:
• Reviewed By:
• Status: Draft / In Review / Approved / Deprecated

Request Details

• Request Number / Ticket ID:
• Business Justification if available:
  (Explain the reason this script was requested. Include problem statement or business case.)

Source Template (if applicable)

• Source Script Template Name:
• Location / Repository:
• Modifications Made:
  (List what was changed from the original template, if used)

Description

• Purpose of the Script:
• Type of Script: Shell / Python / PowerShell / SQL / Other
• Execution Frequency: One-time / Scheduled / On-demand
• Target server(s):
  (list of servers where the script is used)

Input / Parameters

Parameter	Description	Required	Default Value	Example
param1	Just example	no	NULL	value1

Dependencies

• External Libraries / Tools Used:
• Environment Variables:

Deployment & Execution

• Deployment Method:
• Execution Method:
  (e.g., Scheduled Task, Cron Job, Manual Run, Pipeline Trigger)

Run Instructions:

(example of script execution)

./run_script.sh --param1 value1

Error Handling

• Known Errors and Fixes:
• Failure Notifications (if available):
  (e.g., Email alert, Slack webhook, log monitoring tool)

Change History

Version	Date	Author	Description of Change
1.0	YYYY-MM-DD	Your Name	Initial creation