Script Audit Template

Basic Information

Script Name: e.g., build_ebooks.rb
File Path: e.g., scripts/build_ebooks.rb
Audit Date: YYYY-MM-DD
Auditor: Your Name

Primary Purpose:
Brief description of what this script is supposed to do

Command-line Interface:

[Usage example]
ruby script.rb [options]

Input:

Output:

Dependencies:

Can Execute:
☐ Yes, without issues
☐ Yes, with workarounds (describe below)
☐ No, fails (describe below)

Issues/Workarounds:
Description if applicable

Execution Time:
Approximate time to complete execution with typical input

Overall Quality:
☐ Good
☐ Adequate
☐ Poor

Issues Identified:

Good Practices Found:

Error Handling Strategy:
Description of how errors are handled

Failure Modes:

Logging/Reporting:

Documentation Quality:
☐ Good
☐ Adequate
☐ Poor
☐ None

Usage Instructions:
☐ Yes, comprehensive
☐ Yes, partial
☐ No

Documentation Needs:
Describe what documentation should be added or improved

Migration Priority:
☐ High
☐ Medium
☐ Low

Migration Complexity:
☐ High
☐ Medium
☐ Low

Suggested Approach:
Describe how this script should be migrated to Elixir, e.g., Mix task, escript, etc.

Potential Elixir Structure:

defmodule Mix.Tasks.Codexis.YourTask do
  use Mix.Task
  
  @shortdoc "Short description"
  def run(args) do
    # Implementation
  end
end

Risks:

Performance Considerations:

Special Handling Required:

Any other information that doesn't fit in the categories above