Umm Al-Qura University Software Documentation and Technical
College of Computing Writing – CS3123
Computer Science and AI Department First Semester 2024
Source Code Documentations
(SCD)
And
Quality Assurance Documentation
(QAD)
.
(4B)
(king Abduallah Library)
Date: (13/9/2024)
Document Revision History
Version Date Name Description
1
13/9/2024 king The Smart Library
provides e-books and
Abduallah various services
through a digital
Library platform, accessible
anytime by eligible
UQU University users,
including translation,
reading, question
generation, and
summarization.
TABLE OF CONTENTS
1. INTRODUCTION
1.1. Purpose
1.2. Overview
2. Source Code Documentation (SCD)
3. Quality Assurance Documentation (QAD)
3.1. Quality Management Plan
3.2. Test Plan
Section 1 Introduction
1.1 Purpose
The purpose of the document is to comprehensive view and understanding the requirement of “E-book”
For the new prospected solution : “smart library” . It illustrates the requirements of the system. It will
also explain system constraints, interface and interactions with other external applications.
1.2 Overview
The project aims to create a smart library system for the university that allows users to access e-books
through features like automatic translation, text-to-speech reading, and AI-driven summarization. It will
support diverse user needs, including accessibility options, and ensure high availability and quick
response times for a seamless experience.
Section 2 Source Code Documentation (SCD)
import [Link];
import [Link];
// Class representing the Library System
class LibrarySystem {
private List<Book> books;
private List<User> users;
public LibrarySystem() {
books = new ArrayList<>();
users = new ArrayList<>();
}
public void addBook(Book book) {
[Link](book);
}
public void registerUser(User user) {
[Link](user);
}
public List<Book> searchBook(String title) {
List<Book> foundBooks = new ArrayList<>();
for (Book book : books) {
if ([Link]().equalsIgnoreCase(title)) {
[Link](book);
}
}
return foundBooks;
}
2
© 2024 Project Name, Version no. 0.0
}
// Class representing an e-book
class Book {
private String title;
private String author;
private String genre;
private boolean availability;
public Book(String title, String author, String genre, boolean availability) {
[Link] = title;
[Link] = author;
[Link] = genre;
[Link] = availability;
}
public String getTitle() {
return title;
}
// Additional getters and setters can be added here
}
// Class representing a user
class User {
private String name;
private String userType; // 'student' or 'librarian'
private List<String> preferences;
public User(String name, String userType) {
[Link] = name;
[Link] = userType;
[Link] = new ArrayList<>();
}
// Additional methods for user preferences can be added here
}
// Class for AI Translation
class AITranslator {
public static String translate(String text, String targetLanguage) {
// Implement translation logic here
return "Translated text to " + targetLanguage;
}
}
// Class for AI Summarization
class AISummarizer {
3
© 2024 Project Name, Version no. 0.0
public static String summarize(String text) {
// Implement summarization logic here
return "Summarized text";
}
}
// Class for Text-to-Speech reading
class AIReader {
public void read(String text) {
// Implement text-to-speech logic here
[Link]("Reading: " + text);
}
}
// Class for extracting questions
class QuestionExtractor {
public static List<String> extractQuestions(Book book, String criteria) {
// Implement question extraction logic based on criteria
List<String> questions = new ArrayList<>();
[Link]("Question 1");
[Link]("Question 2");
return questions;
}
}
// Example Usage
public class Main {
public static void main(String[] args) {
LibrarySystem library = new LibrarySystem();
Book book1 = new Book("Sample Book", "Author A", "Fiction", true);
[Link](book1);
User user1 = new User("Afnan Al-Sharif", "student");
[Link](user1);
// Translate text
String translatedText = [Link]("Hello, World!", "Arabic");
[Link](translatedText);
// Summarize text
String summary = [Link]("This is a sample e-book text.");
[Link](summary);
// Read text
AIReader reader = new AIReader();
[Link]("This is the content being read.");
// Extract questions
4
© 2024 Project Name, Version no. 0.0
List<String> questions = [Link](book1, "easy");
for (String question : questions) {
[Link](question);
}
}
}
Section 3 Quality Assurance Documentation (QAD)
3.1 Quality Management Plan
Quality Management Plan
Class Name: Class ID:
LibrarySystem LS001
Functionality:
Manages books and
users; allows for
addition and search of
books
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To provide a Efficient 99% user Project Manager
centralized handling of satisfaction with
management user requests the library
system for the and book system.
library. management
.
5
© 2024 Project Name, Version no. 0.0
Quality Management Plan
Class Name: Class ID:
Book BK001
Functionality:
Represents an e-book
with attributes like
title, author, genre,
and availability
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To maintain Accurate 100% accuracy in Data Manager
accurate data book information..
representation of e- management
books in the library and retrieval
of book
details.
Quality Management Plan
Class Name: Class ID:
User US001
Functionality:
Represents users
with attributes for
managing
preferences and
types
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To manage user- Improved 95% of users able User Experience lead
specific user to customize their
preferences and experience experience
types efficiently and
customizatio
n options
6
© 2024 Project Name, Version no. 0.0
Quality Management Plan
Class Name: Class ID:
AlTranslator AT001
Functionality:
Translates text into
different languages
using AI
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To facilitate Increased 90% translation Al Specialist
multilingual access accessibility accuracy for
to library resources of e-books supported
for nonnative languages
speakers
Quality Management Plan
Class Name: Class ID:
AlSummarizer AS001
Functionality:
Summarizes e-books
and chapters using Al
techniques
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To provide concise Enhanced 85% of Content Analyst
and accurate comprehensio summaries to be
summaries of e- n and quicker rated as helpful
books access to book by users.
content
7
© 2024 Project Name, Version no. 0.0
Quality Management Plan
Class Name: Class ID:
AlReader AR001
Functionality:
Converts text to
speech for reading e-
books aloud.
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To improve To improve 80% of users find Accessibility Expert
accessibility for accessibility the reading
visually impaired for visually experience
users. impaired satisfactory.
users
Quality Management Plan
Class Name: Class ID:
QuestionExtractor QE001
Functionality:
Extracts questions
from e-books based
on specified criteria.
Performance Measures/Data
Goal Outcome Target Objective Source(s)/
Frequency/Responsible Person
To enhance Improved 75% of users Educational Consultant
learning with retention and report improved
relevant questions understandin study
from book content. g of material effectiveness.
3.2 Test Specifications
.
8
© 2024 Project Name, Version no. 0.0
Step Operator Action Expected Results Observed Pass/
Results Fail
1. User searches for a book by title The book should appear in the Book Pass
results appears as
expected
2. User adds a new book to the library The book should be added Book is Pass
successfully successfully
added
3. User registers a new account Confirmation message should Confirmation Pass
appear received
4. User requests a translation of text The translated text should Translation is Pass
match accurate
5. User requests a summary of a book A concise summary should be Summary is Pass
returned provided
9
© 2024 Project Name, Version no. 0.0
