Spaces:
Sleeping
Sleeping
| <!-- templates/instructions.html --> | |
| <html> | |
| <head> | |
| <title>Instructions - Human Notes Evaluator</title> | |
| <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}"> | |
| <style> | |
| .markdown-body { | |
| font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif; | |
| font-size: 16px; | |
| line-height: 1.5; | |
| word-wrap: break-word; | |
| } | |
| .markdown-body h1 { | |
| margin-top: 24px; | |
| margin-bottom: 16px; | |
| font-weight: 600; | |
| line-height: 1.25; | |
| } | |
| .markdown-body h2 { | |
| margin-top: 24px; | |
| margin-bottom: 16px; | |
| font-weight: 600; | |
| line-height: 1.25; | |
| padding-bottom: 0.3em; | |
| border-bottom: 1px solid #eaecef; | |
| } | |
| .markdown-body h3 { | |
| margin-top: 24px; | |
| margin-bottom: 16px; | |
| font-weight: 600; | |
| line-height: 1.25; | |
| } | |
| .markdown-body p { | |
| margin-top: 0; | |
| margin-bottom: 16px; | |
| } | |
| .markdown-body code { | |
| padding: 0.2em 0.4em; | |
| margin: 0; | |
| font-size: 85%; | |
| background-color: rgba(27,31,35,0.05); | |
| border-radius: 3px; | |
| } | |
| .markdown-body pre { | |
| padding: 16px; | |
| overflow: auto; | |
| font-size: 85%; | |
| line-height: 1.45; | |
| background-color: #f6f8fa; | |
| border-radius: 3px; | |
| } | |
| .markdown-body ul, .markdown-body ol { | |
| padding-left: 2em; | |
| margin-top: 0; | |
| margin-bottom: 16px; | |
| } | |
| .markdown-body blockquote { | |
| padding: 0 1em; | |
| color: #6a737d; | |
| border-left: 0.25em solid #dfe2e5; | |
| margin: 0 0 16px 0; | |
| } | |
| .download-btn { | |
| margin-top: 20px; | |
| margin-bottom: 20px; | |
| } | |
| </style> | |
| </head> | |
| <body> | |
| <div class="container"> | |
| <div class="header"> | |
| <h1>Instructions</h1> | |
| <div class="header-links"> | |
| <a href="{{ url_for('evaluate') }}" class="evaluate-btn">Back to Evaluation</a> | |
| <a href="{{ url_for('index') }}" class="evaluate-btn">Back to Home</a> | |
| </div> | |
| </div> | |
| <div class="markdown-body"> | |
| <h1>Instructions for Using the Human Notes Evaluator</h1> | |
| <p>This document provides detailed instructions for using the Human Notes Evaluator application.</p> | |
| <h2>Contents</h2> | |
| <ol> | |
| <li><a href="#overview">Overview</a></li> | |
| <li><a href="#evaluating-documents">Evaluating Documents</a></li> | |
| <li><a href="#viewing-results">Viewing Results</a></li> | |
| <li><a href="#preparing-documents">Preparing Documents for Evaluation</a></li> | |
| <li><a href="#understanding-criteria">Understanding Evaluation Criteria</a></li> | |
| <li><a href="#troubleshooting">Troubleshooting</a></li> | |
| </ol> | |
| <h2 id="overview">Overview</h2> | |
| <p>The Human Notes Evaluator is designed to systematically assess documents (such as clinical notes or reports) across multiple quality criteria. The application:</p> | |
| <ul> | |
| <li>Presents documents to evaluators in a random order</li> | |
| <li>Collects ratings across 9 quality dimensions on a 1-5 scale</li> | |
| <li>Tracks which documents have been evaluated</li> | |
| <li>Displays results in a table format</li> | |
| </ul> | |
| <h2 id="evaluating-documents">Evaluating Documents</h2> | |
| <ol> | |
| <li>Enter your name in the "Evaluator Name" field</li> | |
| <li>For each criterion, select a rating from 1-5 (Not at all to Extremely)</li> | |
| <li>All criteria must be rated before submission</li> | |
| <li>Click "Submit Evaluation" to record your assessment</li> | |
| <li>The system will then present another random document for evaluation</li> | |
| <li>Continue until all documents have been evaluated</li> | |
| </ol> | |
| <h2 id="viewing-results">Viewing Results</h2> | |
| <ol> | |
| <li>Click the "View Results" button in the header</li> | |
| <li>Results are displayed in a table showing: | |
| <ul> | |
| <li>Timestamp of evaluation</li> | |
| <li>Document identifier</li> | |
| <li>Document description (if provided)</li> | |
| <li>Evaluator name</li> | |
| <li>Scores for each criterion</li> | |
| </ul> | |
| </li> | |
| </ol> | |
| <h2 id="preparing-documents">Preparing Documents for Evaluation</h2> | |
| <p>To add your own documents for evaluation:</p> | |
| <ol> | |
| <li>Download the template file (<a href="{{ url_for('download_template') }}">sample_documents_template.csv</a>) from the application</li> | |
| <li>Open the template in a spreadsheet program (Excel, Google Sheets, etc.)</li> | |
| <li>Add your documents using the following format: | |
| <ul> | |
| <li><strong>filename</strong>: A unique identifier for each document (not shown to evaluators)</li> | |
| <li><strong>description</strong>: (Optional) A brief description of the document context</li> | |
| <li><strong>note</strong>: The full text of the document to be evaluated</li> | |
| </ul> | |
| </li> | |
| <li>Save the file as CSV format</li> | |
| <li>Upload the completed CSV file using the file upload on the home page</li> | |
| </ol> | |
| <h3>Example CSV Format:</h3> | |
| <pre>filename,description,note | |
| doc1.txt,Patient with heart failure,This is the full text of the first document... | |
| doc2.txt,Emergency room visit,This is the full text of the second document... | |
| doc3.txt,,This is a document without a description...</pre> | |
| <h2 id="understanding-criteria">Understanding Evaluation Criteria</h2> | |
| <p>Documents are evaluated on a 1-5 scale (Not at all = 1, Extremely = 5) across these criteria:</p> | |
| <ol> | |
| {% for i in range(criteria|length) %} | |
| <li> | |
| <strong>{{ criteria[i] }}</strong><br> | |
| <em>{{ descriptions[i] }}</em> | |
| </li> | |
| {% endfor %} | |
| </ol> | |
| <h2 id="troubleshooting">Troubleshooting</h2> | |
| <h3>Common Issues:</h3> | |
| <ol> | |
| <li> | |
| <strong>No documents available for evaluation</strong> | |
| <ul> | |
| <li>Ensure the CSV file you uploaded exists and is properly formatted</li> | |
| <li>Check that not all documents have already been evaluated</li> | |
| </ul> | |
| </li> | |
| <li> | |
| <strong>Unable to submit evaluation</strong> | |
| <ul> | |
| <li>Verify that all criteria have been rated</li> | |
| </ul> | |
| </li> | |
| <li> | |
| <strong>Results not showing</strong> | |
| <ul> | |
| <li>Results will only appear after at least one document has been evaluated</li> | |
| </ul> | |
| </li> | |
| </ol> | |
| <p>For additional support, please contact your administrator.</p> | |
| <div class="download-btn"> | |
| <a href="{{ url_for('download_instructions') }}" class="submit-btn">Download Instructions as Markdown</a> | |
| </div> | |
| </div> | |
| {% with messages = get_flashed_messages() %} | |
| {% if messages %} | |
| {% for message in messages %} | |
| <div class="alert">{{ message }}</div> | |
| {% endfor %} | |
| {% endif %} | |
| {% endwith %} | |
| </div> | |
| </body> | |
| </html> |