Commit 4c6c6d

2025-09-25 05:39:40 Shilpa: Adjusting headings
Projects/Audit-matic.md ..
@@ 1,22 1,26 @@
# Audit-matic
- Project: AuditMatic
+ **Project**: AuditMatic
- Tagline: Automating CMMI compliance by bridging the gap between business requirements and development artifacts.
+ **Tagline**: Automating CMMI compliance by bridging the gap between business requirements and development artifacts.
- Team: Fusion
+ **Team**: Fusion
- Project Status: Planning
+ **Project Status**: Planning
+
+ **Overview**
- Overview
This project aims to develop a custom AI solution, AuditMatic, that automates the CMMI compliance auditing process. For many development teams, ensuring that engineering work aligns with business requirements is a manual, time-consuming, and error-prone task. This system solves that problem by serving as an intelligent bridge between business documents and development tools like Jira and GitLab.
The core of our solution is an AI-powered pipeline that ingests unstructured business requirements documents, uses Natural Language Processing (NLP) to extract key identifiers (like ticket numbers and commit hashes), and then pulls live data from development tools via their APIs. By programmatically cross-validating this information against a set of CMMI rules, the system can generate an instant, detailed compliance report, flagging discrepancies that would otherwise require hours of manual auditing.
- The Problem
+ **The Problem**
+
CMMI compliance auditing is a critical but highly inefficient process for software development organizations. It requires auditors to manually read through complex business requirements documents and then painstakingly cross-reference every stated requirement with tickets in Jira and commits in GitLab. This manual process is not only slow and costly but also susceptible to human error, potentially leading to failed audits and non-compliance.
- Our AI Solution
+ **Our AI Solution
+ **
+
What does it do?
AuditMatic is a web application that ingests business requirements documents and automatically checks for CMMI compliance by cross-validating them against live data from Jira and GitLab.
@@ 32,7 36,8 @@
What makes it innovative?
It replaces a manual, human-driven audit process with an automated, AI-driven pipeline. It is a practical application of AI engineering, combining off-the-shelf NLP models with a custom rule-based expert system to solve a specific, high-value business problem efficiently.
- Technology Stack
+ **Technology Stack**
+
AI/ML Models: spaCy (for NLP/NER), Custom Rule-Based Expert System
Frameworks & Libraries: PyMuPDF, python-docx, jira, python-gitlab, multer
@@ 47,7 52,8 @@
APIs Used: Jira API, GitLab API
- Project Architecture
+ **Project Architecture**
+
The system follows a three-tier architecture where the frontend, backend, and AI core work in sequence to process a request.
Code snippet
@@ 63,22 69,31 @@
C -->|8. Return JSON Report| B;
B -->|9. Forward JSON Report| A;
A -->|10. Display Formatted Report| G[User];
- Challenges & Learnings
+
+ **Challenges & Learnings
+ **
+
Anticipated Challenges: The primary challenges will be creating robust NLP patterns to handle variations in document formats and ensuring seamless orchestration between the three different technology stacks (React, Node.js, Python). Handling API rate limits and errors from Jira and GitLab will also be critical.
Anticipated Learnings: This project will provide significant learnings in practical AI engineering, specifically in combining pre-built NLP models with custom rule-based systems. The team will gain experience in building polyglot microservices and the importance of clean data extraction from unstructured sources.
- Future Roadmap
+ **Future Roadmap
+ **
+
Short-term Goal: Successfully build the pilot with the core compliance checks (Traceability, Accountability, Completeness) using regex-based entity recognition.
Medium-term Goal: Train a custom NLP model using spaCy to recognize more complex or non-standard internal project identifiers, improving the system's accuracy and flexibility.
Long-term Goal: Expand the system by training a machine learning classifier to automatically categorize different types of requirement documents (e.g., "Test Plan," "Risk Plan," "Functional Spec") to apply different rule sets.
- Repository & Live Demo
- GitHub Repository: [Link to your code repo here]
+ **Repository & Live Demo
+ **
+
+ **GitHub Repository**: [Link to your code repo here]
+
+ **Live Demo**: [Link to your live demo or video walkthrough here]
- Live Demo: [Link to your live demo or video walkthrough here]
+ **Screenshots / Demo Video
+ **
- Screenshots / Demo Video
(Embed screenshots or a video of the working web application here)
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9