How to Use These Templates

Each template below corresponds to a specific phase or requirement in the EDD SOP. Download the Markdown files, fill them out in any text editor, and include the completed versions in your tool documentation package. Templates are listed in the order you will typically use them during a project.

SOP Appendix A — Phase 1: Planning

Problem Definition Worksheet

The starting point for every EDD project. This template captures the problem you are solving, who you are solving it for, measurable success criteria, required functions, data considerations, and required approvals. Your supervisor must sign this document before development begins.

Key Sections Preview

Tool Information Tool Name | Developer | Date Problem Statement Describe the problem in 2-3 sentences. Focus on workflow gap, inefficiency, or unmet need. Target Users Primary User Group | Secondary Users | Estimated Count Success Criteria # | Metric | Current State | Target State | How Measured Required Functions # | Function Description | Priority (Must / Should / Nice) Data Considerations PII handling | PHI handling | Security controls checklist Approvals Developer signature | Supervisor signature | Dates
Build Process — Phase 2: Development

Development Journal

Track your build process session by session. Record what you accomplished, blockers encountered, hours spent, and the AI prompts that produced the best results. This journal feeds directly into your Replication Guide and helps future developers understand how the tool was built.

Key Sections Preview

Project Information Project Name | Developer | Start Date | Target Completion Session Log (repeat per session) Date | Hours What was accomplished Blockers or challenges Next steps Running Total Hours Development | Testing | Documentation | Rework | Total Lessons Learned Insights gained during the build process AI Prompts That Worked Well Purpose | AI Tool Used | Prompt Text | Why it worked
SOP Appendix B — Phase 3: Quality Assurance

QA Review Checklist

The formal quality gate before deployment. A qualified reviewer (subject matter expert, experienced developer, or supervisor) evaluates your tool across five categories: functionality, user testing, documentation completeness, compliance, and turnover readiness. All criteria must pass before deployment.

Key Sections Preview

Review Information Tool Name | Date | Developer | Reviewer 1. Functionality (6 criteria) Functions work as intended | Error handling | UI intuitive Performance acceptable | Outputs accurate | Handles data volumes 2. User Testing (4 criteria) Minimum 3 users tested | Feedback collected Critical items addressed | Users complete tasks independently 3. Documentation (6 criteria) User Guide | Replication Guide | Adaptation Guide Maintenance Guide | Clear writing | Current screenshots 4. Compliance (6 criteria) No unauthorized PII/PHI | Approved platform Security controls | PIA completed if required 5. Turnover Readiness (5 criteria) Tool registered | Maintainer designated Documentation accessible | Backup plan exists Review Result Approved | Revisions Required (with specific items)
SOP Appendix C — Phase 4: Deployment

Tool Registry Entry

Register your deployed tool in the organizational Tool Registry. This entry tracks tool identification, description, user counts, documentation location, current maintainer, data sensitivity classification, and review schedule. Update this record whenever the tool's status, maintainer, or version changes.

Key Sections Preview

Tool Identification Tool Name | Version | Developer | Deployment Date Description Platform | What the tool does and the problem it solves Users Target User Groups | Current User Count Documentation and Support Documentation Location | Current Maintainer | Contact Status Active / Deprecated / Under Revision Data Sensitivity: No PII / PII Controlled Change Log Date | Version | Changed By | Description of Change
Complete Package — All Phases

Documentation Package Outline

The master outline for your complete documentation package. It defines the structure and required content for all four deliverable guides: User Guide (2-5 pages), Replication Guide (10-30 pages), Adaptation Guide (5-10 pages), and Maintenance Guide (5-10 pages). All four must be completed before QA review.

Key Sections Preview

1. User Guide (2-5 pages) Audience: End users with no technical background Sections: Purpose, Access/Setup, How-To with screenshots, FAQ, Getting Help 2. Replication Guide (10-30 pages) Audience: Developer who needs to rebuild from scratch Sections: Architecture, Data Structure, Step-by-Step Rebuild, Configuration, AI Prompts Used, Testing/Validation 3. Adaptation Guide (5-10 pages) Audience: Developer modifying for a different context Sections: Adaptation targets, Configurable Parameters, Data Source Mods, UI Mods, What Not to Change 4. Maintenance Guide (5-10 pages) Audience: Designated maintainer after developer departs Sections: Troubleshooting, Update Procedures, Monitoring, Dependency Management, Turnover Checklist

Reminder

The Problem Definition Worksheet must be completed and approved by your supervisor before any development begins. All five templates must be completed and included in your documentation package before the tool can pass QA review and be registered for deployment. See the SOP for the complete process.