api / templates /document.html
lokesh341's picture
Create document.html
0242297 verified
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Subcontractor Performance Review Automation Document</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 40px;
background-color: #f9f9f9;
line-height: 1.6;
}
.container {
max-width: 1000px;
margin: 0 auto;
background: white;
padding: 30px;
border-radius: 8px;
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
}
h1, h2, h3 {
color: #2c3e50;
}
h1 {
border-bottom: 2px solid #3498db;
padding-bottom: 10px;
}
h2 {
margin-top: 30px;
border-bottom: 1px solid #ecf0f1;
padding-bottom: 5px;
}
h3 {
margin-top: 20px;
color: #34495e;
}
p, li {
color: #555;
}
ul {
padding-left: 20px;
}
table {
width: 100%;
border-collapse: collapse;
margin: 20px 0;
}
th, td {
padding: 12px;
border: 1px solid #ddd;
text-align: left;
}
th {
background-color: #3498db;
color: white;
}
tr:nth-child(even) {
background-color: #f2f2f2;
}
.section {
margin-bottom: 40px;
}
.toc {
background-color: #ecf0f1;
padding: 15px;
border-radius: 5px;
margin-bottom: 30px;
}
.toc ul {
list-style-type: none;
padding: 0;
}
.toc li {
margin: 5px 0;
}
.toc a {
color: #2980b9;
text-decoration: none;
}
.toc a:hover {
text-decoration: underline;
}
</style>
</head>
<body>
<div class="container">
<h1>Subcontractor Performance Review Automation</h1>
<p><strong>Client:</strong> Internal MVP Launch (Phase 1)</p>
<p><strong>Prepared By:</strong> Sathkrutha Tech Solutions</p>
<p><strong>Date:</strong> May 3, 2025</p>
<!-- Table of Contents -->
<div class="toc section">
<h2>Table of Contents</h2>
<ul>
<li><a href="#brd">Business Requirement Document (BRD)</a>
<ul>
<li><a href="#executive-summary">1.1 Executive Summary</a></li>
<li><a href="#business-objectives">1.2 Business Objectives</a></li>
<li><a href="#stakeholders">1.3 Stakeholders</a></li>
<li><a href="#functional-requirements">1.4 Functional Requirements</a></li>
<li><a href="#non-functional-requirements">1.5 Non-Functional Requirements</a></li>
<li><a href="#scope">1.6 Scope</a></li>
<li><a href="#assumptions">1.7 Assumptions</a></li>
<li><a href="#success-metrics">1.8 Success Metrics</a></li>
<li><a href="#risks-mitigations">1.9 Risks & Mitigations</a></li>
<li><a href="#gtm-plan">1.10 GTM Plan</a></li>
<li><a href="#approval">1.11 Approval</a></li>
</ul>
</li>
<li><a href="#sdd">Solution Design Document (SDD)</a>
<ul>
<li><a href="#architecture-overview">2.1 Architecture Overview</a></li>
<li><a href="#data-flow-diagram">2.2 Data Flow Diagram</a></li>
<li><a href="#salesforce-object-design">2.3 Salesforce Object Design</a></li>
<li><a href="#ai-model-design">2.4 AI Model Design</a></li>
<li><a href="#ui-design">2.5 User Interface Design</a></li>
</ul>
</li>
<li><a href="#tsd">Technical Specification Document (TSD)</a>
<ul>
<li><a href="#api-integrations">3.1 API Integrations</a></li>
<li><a href="#platform-hosting">3.2 Platform/Hosting</a></li>
<li><a href="#performance-targets">3.3 Performance Targets</a></li>
<li><a href="#security-considerations">3.4 Security Considerations</a></li>
<li><a href="#testing-qa-plan">3.5 Testing & QA Plan</a></li>
</ul>
</li>
<li><a href="#gtm-user-stories">STPL Marketing & GTM User Stories</a></li>
</ul>
</div>
<!-- Business Requirement Document (BRD) -->
<div class="section" id="brd">
<h2>Business Requirement Document (BRD)</h2>
<div id="executive-summary">
<h3>1.1 Executive Summary</h3>
<p>This app scores and ranks subcontractors based on work quality, timeliness, incident rates, compliance, and communication, using data-driven review automation to support vendor decisions.</p>
</div>
<div id="business-objectives">
<h3>1.2 Business Objectives</h3>
<p>Automate and standardize subcontractor evaluations across projects to improve quality control, streamline procurement, and incentivize better vendor performance.</p>
</div>
<div id="stakeholders">
<h3>1.3 Stakeholders</h3>
<table>
<tr>
<th>Role</th>
<th>Name</th>
</tr>
<tr>
<td>Product Owner</td>
<td>Sathkrutha Delivery Lead</td>
</tr>
<tr>
<td>Solution Architect</td>
<td>Salesforce Engineering Team</td>
</tr>
<tr>
<td>AI Engineer</td>
<td>Vendor Scoring Analyst</td>
</tr>
<tr>
<td>QA & Ops</td>
<td>Subcontractor Review QA Team</td>
</tr>
<tr>
<td>Business Lead</td>
<td>STPL Procurement Head</td>
</tr>
</table>
</div>
<div id="functional-requirements">
<h3>1.4 Functional Requirements</h3>
<ul>
<li>Log work completion, delay reports, incident logs</li>
<li>Score vendors on quality, time, safety, and conduct</li>
<li>Generate monthly performance report with trend</li>
<li>Display leaderboard and issue risk alerts for low rank</li>
<li>Auto-send vendor reports and PDF certification</li>
</ul>
</div>
<div id="non-functional-requirements">
<h3>1.5 Non-Functional Requirements</h3>
<ul>
<li>Report generation < 10 seconds per vendor</li>
<li>Vendor ranking across 500+ subcontractors</li>
<li>Support multilingual report headers</li>
<li>Report archive with 1-year retention</li>
</ul>
</div>
<div id="scope">
<h3>1.6 Scope</h3>
<p><strong>In Scope:</strong></p>
<ul>
<li>Monthly vendor scoring and reporting</li>
<li>Leaderboards, alerts, and certification</li>
<li>Client/PM view of vendor scores</li>
</ul>
<p><strong>Out of Scope:</strong></p>
<ul>
<li>Contract creation or payment workflows</li>
<li>Legal penalty enforcement</li>
</ul>
</div>
<div id="assumptions">
<h3>1.7 Assumptions</h3>
<ul>
<li>All subcontractors are tagged to projects</li>
<li>Incidents and quality logs are submitted weekly</li>
<li>Score weightages pre-agreed with PMO</li>
</ul>
</div>
<div id="success-metrics">
<h3>1.8 Success Metrics</h3>
<ul>
<li>Top vendor pool accuracy > 90%</li>
<li>Monthly scoring coverage > 95% vendors</li>
<li>Alerts resolved within 72 hours</li>
</ul>
</div>
<div id="risks-mitigations">
<h3>1.9 Risks & Mitigations</h3>
<ul>
<li>Score disputes → include comment and appeal option</li>
<li>Fake reports → require photo/time geotag evidence</li>
</ul>
</div>
<div id="gtm-plan">
<h3>1.10 GTM Plan</h3>
<ul>
<li>Launch with 20+ active vendors across 3 projects</li>
<li>Poster: 'Measure What Matters – Vendor Edition'</li>
<li>Show live leaderboard and report export flow</li>
<li>Price by vendor count or score run frequency</li>
</ul>
</div>
<div id="approval">
<h3>1.11 Approval</h3>
<table>
<tr>
<th>Role</th>
<th>Name</th>
<th>Signature / Date</th>
</tr>
<tr>
<td>Product Owner</td>
<td>Sathkrutha Delivery Lead</td>
<td></td>
</tr>
<tr>
<td>Engineering Lead</td>
<td>Salesforce AI Architect</td>
<td></td>
</tr>
<tr>
<td>Business Lead</td>
<td>STPL Strategic Head</td>
<td></td>
</tr>
</table>
</div>
</div>
<!-- Solution Design Document (SDD) -->
<div class="section" id="sdd">
<h2>Solution Design Document (SDD)</h2>
<div id="architecture-overview">
<h3>2.1 Architecture Overview</h3>
<p>Subcontractor work logs, delay notices, quality reports, and incidents are ingested by Salesforce. A Hugging Face AI model computes monthly scores across multiple dimensions, enabling risk flagging and automatic PDF report generation. Reports are shared with vendors and procurement heads via dashboards and email.</p>
</div>
<div id="data-flow-diagram">
<h3>2.2 Data Flow Diagram</h3>
<p>Work Logs + Delay + Quality Logs → Salesforce Site → Hugging Face AI Vendor Scoring → Scorecard + Alerts → Dashboard + Certification PDF</p>
</div>
<div id="salesforce-object-design">
<h3>2.3 Salesforce Object Design</h3>
<p><strong>Object:</strong> Subcontractor_Performance_Score__c</p>
<p><strong>Fields:</strong></p>
<ul>
<li>Vendor_ID__c (Lookup)</li>
<li>Month__c (Date)</li>
<li>Quality_Score__c (Percent)</li>
<li>Timeliness_Score__c (Percent)</li>
<li>Safety_Score__c (Percent)</li>
<li>Communication_Score__c (Percent)</li>
<li>Final_Score__c (Formula)</li>
<li>Certification_URL__c (URL)</li>
<li>Alert_Flag__c (Checkbox)</li>
</ul>
</div>
<div id="ai-model-design">
<h3>2.4 AI Model Design</h3>
<p><strong>Model:</strong> Weighted Scoring with Rules + Trend Detection</p>
<p><strong>Inputs:</strong> Delay % logs, QA incidents, safety compliance, feedback logs</p>
<p><strong>Outputs:</strong> Score breakdown, final score, trend deviation</p>
<p><strong>Hosted on:</strong> Hugging Face with JSON response</p>
</div>
<div id="ui-design">
<h3>2.5 User Interface Design</h3>
<ul>
<li>Vendor scorecard with breakdown and trend arrows</li>
<li>Leaderboard of top-performing vendors</li>
<li>PDF certificate with monthly badge</li>
<li>Alert icon for underperforming vendors</li>
<li>Admin screen for score adjustment audit trail</li>
</ul>
</div>
</div>
<!-- Technical Specification Document (TSD) -->
<div class="section" id="tsd">
<h2>Technical Specification Document (TSD)</h2>
<div id="api-integrations">
<h3>3.1 API Integrations</h3>
<p>Vendor logs posted to Hugging Face monthly. Response includes score categories and alert flag. Stored in Salesforce and linked to report generator. Certification emailed to vendor and procurement.</p>
</div>
<div id="platform-hosting">
<h3>3.2 Platform/Hosting</h3>
<p><strong>Frontend:</strong> Salesforce Vendor Portal + Admin View</p>
<p><strong>Backend:</strong> Hugging Face Scoring Engine</p>
<p><strong>Data Sources:</strong> Delay logs, QA reports, incident database</p>
<p><strong>Reports:</strong> Certification with multilingual title support</p>
</div>
<div id="performance-targets">
<h3>3.3 Performance Targets</h3>
<ul>
<li>Score calculation < 8 seconds</li>
<li>Certification generation < 5 seconds</li>
<li>Support 1000+ vendors across 30+ projects</li>
</ul>
</div>
<div id="security-considerations">
<h3>3.4 Security Considerations</h3>
<ul>
<li>Scores editable by authorized role only</li>
<li>Audit log of score edits maintained</li>
<li>Certificates tokenized for secure vendor download</li>
</ul>
</div>
<div id="testing-qa-plan">
<h3>3.5 Testing & QA Plan</h3>
<ul>
<li>Simulate scoring for 25 vendors</li>
<li>Cross-validate category breakdowns</li>
<li>Review alert triggering logic</li>
<li>PDF formatting test in English + Telugu</li>
</ul>
</div>
</div>
<!-- STPL Marketing & GTM User Stories -->
<div class="section" id="gtm-user-stories">
<h2>STPL Marketing & GTM User Stories</h2>
<table>
<tr>
<th>ID</th>
<th>Role</th>
<th>User Story</th>
<th>Acceptance Criteria</th>
<th>Tasks</th>
<th>Assumptions</th>
</tr>
<tr>
<td>STPL-VND-001</td>
<td>Procurement</td>
<td>View vendor performance score</td>
<td>Score + alert flag by 1st of month</td>
<td>Upload logs</td>
<td>Vendor assigned</td>
</tr>
<tr>
<td>STPL-VND-002</td>
<td>Vendor</td>
<td>Download monthly certificate</td>
<td>PDF with badge and breakdown</td>
<td>Auto-email on upload</td>
<td>Access setup</td>
</tr>
<tr>
<td>STPL-VND-003</td>
<td>Marketing</td>
<td>Poster: 'Rated to Perform – Vendor Metrics'</td>
<td>Score breakdown with rank visual</td>
<td>Design 3 options</td>
<td>Sample vendor filled</td>
</tr>
<tr>
<td>STPL-VND-004</td>
<td>Sales</td>
<td>Plan per vendor or per batch</td>
<td>Support 25/50/100 vendor pricing</td>
<td>Add certificate and alert cost</td>
<td>Volume discount done</td>
</tr>
<tr>
<td>STPL-VND-005</td>
<td>QA</td>
<td>Score correctness check</td>
<td><5% deviation across 10 test cases</td>
<td>Validate inputs</td>
<td>Logs verified</td>
</tr>
</table>
</div>
</div>
</body>
</html>