-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDocDuckGuidedTour.html
545 lines (472 loc) · 38.6 KB
/
DocDuckGuidedTour.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
<!DOCTYPE html>
<!-- Guided tour presented through some HTML slides
-- Everything stored in one page
-->
<html>
<head>
<title>DocDuck Guided Tour</title>
<style>
* { margin: 0; box-sizing: border-box }
body {
display: grid;
grid-template-rows: 10vh 90vh;
grid-template-columns: 100vw;
}
nav {
grid-row: 1 / 2;
background-color: #1f5398;
display: flex;
justify-content: center;
align-items: center;
font-size: 2.666rem;
color: white
}
.slide-container {
grid-row: 2 / 3;
display: grid;
grid-template-rows: 92% 8%;
grid-template-columns: 100%;
}
.slide-container > .slide-conts {
border: 1px solid black;
margin: 1vh;
grid-row: 1 / 2;
display: none;
padding: 2vh;
overflow-y: scroll;
}
.slide-conts h1 {
font-size: 2.333rem;
}
.slide-conts h2 {
font-size: 1.888rem;
}
.slide-conts h3 {
font-size: 1.5rem;
}
.slide-conts p, li {
font-size: 1.333rem;
}
.slide-conts#active {
display: inline-block;
}
.slide-container > .slide-buttons {
grid-row: 2 / 3;
background-color: #1f5398;
display: flex;
justify-content: center;
align-items: center;
}
.slide-container > .slide-buttons button {
margin: 0 20px;
font-size: 1.7rem
}
.center {
text-align: center;
display: block;
margin-left: auto;
margin-right: auto;
}
.centerImg {
text-align: center;
display: block;
margin-left: auto;
margin-right: auto;
width: 30%;
}
.left {
float: left;
margin: 0 20px;
}
.right {
float: right;
margin: 0 20px;
}
</style>
</head>
<body>
<nav>
<p class="nav-text">DocDuck Guided Tour</p>
</nav>
<div class="slide-container">
<div class="slide-conts" id="active" data-current="a1" data-next="a2" data-prev="a14">
<br>
<img src="assets/img/docducklogo.png" style="max-width: 60%;" class="centerImg" />
<br>
<!-- Header/Title -->
<h1 class="center">DocDuck HTML Guided Tour</h1>
<!-- <br> is a break to add a bit of white space between sections -->
<br>
<h2>Introduction</h2>
<br>
<!-- Paragraphs/Normal text, add extra <br> between if you want to form paragraphs -->
<p>This webpage has been created to provide an HTML tour of our product and all associated deliverables. The tour has been organised into multiple slides with one slide per topic, and you can navigate through these slides using the "next slide" button at the bottom of the page. In this tour you will find pages which explain what DocDuck is, what work we have achieved so far, and how we have worked as a team.</p>
<br>
<p>Additionally, you will see sections based on each of our deliverables that summarise key components of the documents as well as links and references to all our completed documents</p>
<br>
<h2>About DocDuck</h2>
<br>
<p>DocDuck is a maintenance engineering app designed to assist with documentation in the engineering workspace, From keeping track of calibration, audit and diagnostic dates to having a full virtual library of every breakdown ever worked on and every part ever used or purchased. DocDuck is capable of all these features and more.</p>
</div>
<!-- SLIDE 2 -->
<!-- data-current is the current slide, data-next is the slide to go to next on pressing the button -->
<div class="slide-conts" data-current="a2" data-next="a3" data-prev="a1">
<h1>Quality Assurance Manual</h1>
<br>
<p> The Quality Assurance Manual is used to ensure quality is maintained suring the project. The document is designed as reference for employees, clients and stakeholders.
It is intended to ensure that high quality and consistent standards are adhered to throughout the company's activities. The document establishes the framework for each role and their
responsibilities, the deliverables and project management and development methodologies </p>
<br>
<p>Each member of the group completed the section for their primary role. This ensures that they are understand the level of quality expected in their contributions to the project.
Each member has generated a list of risk managements and quality assurance metrics related to their individual responsibilites. This was to ensure a specific and measurable metric of quality. The QA Manual drafts were sent to the client for review and feedback was integrated for each draft. The final version was reviewed by the whole group and was updated after release</p>
<br>
<p>The Project Management Methodology serves as an important reference for the design and programming components of the project. It clearly lays out the specific method to be used for successful
implementation of agile development. This is to ensure that the programming created by each programmer is compatible with each other</p>
<br>
<p>Below are links to draft and released versions of the document:</p>
<br>
<!-- File needs adding into /assets/docs -->
<p><a href="assets/docs/qa_manual/G1_DocDuck Quality_Assurance_Manual_v0.1.pdf" target="_blank">Quality Assurance Manual Draft 0.1</a></p>
<p><a href="assets/docs/qa_manual/G1_DocDuck_Quality_Assurance_Manual_v0.2.pdf" target="_blank">Quality Assurance Manual Draft 0.2</a></p>
<p><a href="assets/docs/qa_manual/G1_DocDuck_Quality_Assurance_Manual_v1.0.pdf" target="_blank">Quality Assurance Manual Release 1</a></p>
<p><a href="assets/docs/qa_manual/G1_DocDuck_Quality_Assurance_Manual_v1.1.pdf" target="_blank">Quality Assurance Manual Release 1.1</a></p>
<p><a href="assets/docs/qa_manual/G1_DocDuck_Quality_Assurance_Manual_v1.2.pdf" target="_blank">Quality Assurance Manual Release 1.2</a></p>
</div>
<!-- SLIDE 3 -->
<div class="slide-conts" data-current="a3" data-next="a4" data-prev="a2">
<h1>Functional Specification</h1>
<br>
<p>The Function Specification outlines the functionality and requirements for the software. It is designed to lay out, in easy to understand terms, the specifics of the
project. The Functional Specification acts as a blueprint for the developers and designers when creating the program. The document contains sections describing: </p>
<ul>
<li>Product Overview</li>
<li>Product Scope</li>
<li>Solution Overview</li>
<li>Functional Specifications</li>
<li>System Configurations</li>
<li>Other system and none functional requirements</li>
<li>Integration Requirements</li>
</ul>
<br>
<p>The requirements and use cases are used to facilitate the ease of use of object oriented programming and agile development. The Project Overview and Scope ensure that stakeholders can clearly and concisely see the scope of the project so that they can easily understand what they are investing in.</p>
<br>
<p>To ensure that the Functional Specification was completed to a high standard, the individual subsections were divided between the group members. Draft versions were sent to the client for feedback which was integrated into the next release. The document was reviewed by the whole group prior to release and continued to be updated after release.</p>
<br>
<p>Below are links to draft and released versions of the document:</p>
<br>
<!-- File needs adding into /assets/docs/ -->
<p><a href="assets/docs/func-spec/G1-DocDuck-Functional-Specification-v0.1.pdf" target="_blank">Functional Specification Draft 1</a></p>
<p><a href="assets/docs/func-spec/G1-DocDuck-Functional-Specification-v0.2.pdf" target="_blank">Functional Specification Draft 2</a></p>
<p><a href="assets/docs/func-spec/G1-DocDuck-Functional-Specification-v0.3.pdf" target="_blank">Functional Specification Draft 3</a></p>
<p><a href="assets/docs/func-spec/G1-DocDuck-Functional-Specification-v1.0.pdf" target="_blank">Functional Specification Release 1</a></p>
<p><a href="assets/docs/func-spec/G1-DocDuck-Functional-Specification-v1.1.pdf" target="_blank">Functional Specification Release 1.1</a></p>
</div>
<!-- SLIDE 4 -->
<div class="slide-conts" data-current="a4" data-next="a5" data-prev="a3">
<h1>Financial Business Plan</h1>
<br>
<p>The Financial Business Plan outlines the financial goals and objectives for potential investors. It provides a detailed overview of the product, the company that will create it as well as the financial plans and strategies that will ensure the project meets its financial targets. The plan is designed to convince an investor to invest in the product and to give them the confidence and vision to support it.</p>
<br>
<p>The Financial Business Plan was completed largely by the Financial Managers with assistance from some other members.</p>
<br>
<p>The Business Plan uses graphs and tables to lay out the required costs for completion of the project, breaking these down into week-by-week and cost-by-cost bases. This allows a potential investor to see an accurate and itemised vue of where and when costs are expected to occur.</p>
<br>
<p>Below are links to draft and released versions of the document:</p>
<br>
<!-- File needs adding into /assets/docs/ -->
<p><a href="assets/docs/finance/G1 DocDuck Financial Business Plan v0.1.pdf" target="_blank">Financial Business Plan Draft 1</a></p>
<p><a href="assets/docs/finance/G1 DocDuck Financial Business Plan v0.2.pdf" target="_blank">Financial Business Plan Draft 2</a></p>
<p><a href="assets/docs/finance/G1 DocDuck Financial Business Plan v1.0.pdf" target="_blank">Financial Business Plan Release 1</a></p>
<br>
<h2> Financial Reports </h2>
<br>
<p>Below are links to the Financial Reports, which document the financial progress of the project. They are used to track our spendings compared to our assigned budget.</p>
<br>
<p><a href="assets/docs/finance/DocDuck_Financial_Report_1.pdf" target="_blank">Financial Report 1</a></p>
<p><a href="assets/docs/finance/DocDuck_Financial_Report_2.pdf" target="_blank">Financial Report 2</a></p>
<p><a href="assets/docs/finance/DocDuck_Financial_Report_3.pdf" target="_blank">Financial Report 3</a></p>
<p><a href="assets/docs/finance/DocDuck_Financial_Summary_Report.pdf" target="_blank">Final Financial Summary Report</a></p>
</div>
<!-- SLIDE 5 -->
<div class="slide-conts" data-current="a5" data-next="a6" data-prev="a4">
<h1>Marketing</h1>
<br>
<p>This slide aims to introduce you to DocDucks marketing strategies.</p>
<br>
<p>DocDuck is a cost effective and user friendly software designed with customers at the heart -
streamlining the machine management process for engineering startups and small businesses.
We have created a Marketing Plan which includes a detailed product analysis, pricing proposals and various marketing strategies.
The document contains the following sections:</p>
<br>
<ul>
<li>Market Research - An analysis of key competitors, including MaintainX and Asset Panda,
focusing on their features, pricing, strengths, and weaknesses.</li>
<li>Unique Selling Points (USPs) - These highlight DocDucks distinctive features such as our
comprehensive repair logging system, friendly UI and advanced security measures.</li>
<li>Target Audience - This defines the primary users of DocDuck, specifically engineering startups
as well as discussing their needs and challenges.</li>
<li>SWOT Analysis - A detailed examination of our strengths, weaknesses, opportunities and
threats.</li>
<li>Marketing Strategies and Distribution Channels - How we plan to advertise our product and deliver it to customers</li>
<li>Customer Segmentation - A breakdown of the customer segments, focusing on the B2B
Business to Business segment. This looks at engineering startups, including their goals,
frustrations and what problems DocDuck can solve for them.</li>
<h1>Marketing Plan</h1>
<br>
<p>Our Marketing Plan outlines our strategies and approaches for promoting our product.
This document contains the following sections:</p>
<ul>
<li>Competitive Market Analysis</li>
<li>Pricing Proposal</li>
<li>Design Theory</li>
</ul>
<br>
<p>The Marketing Plan is included below.</p>
<br>
<p>A marketing portfolio has been created which goes into further detail on what is discussed in the marketing plan. There is
a link to view it here, however it is also included below:
<a href="https://app.validatestartup.com/portfolio/b92a13a8-e227-465f-94a5-27e7dd7675ed/i-p-t-b-tg-d-cs-vp-ca-cr-ch-fe-ka-v-f-c" target="_blank">https://app.validatestartup.com/portfolio/docduck</a>
</p>
<br>
<p>A questionnaire has been designed with the intention of gathering the insight of our potential users
and their opinions of our app. The questionnaire is created with Google Forms, URL:
<a href="https://forms.gle/HpwmrwU6tLcNtMvNA" target="_blank">https://forms.gle/questionnaire</a> Participants have been asked 13 questions about their:</p>
<br>
<ul>
<li>Occupation</li>
<li>Company Size</li>
<li>Machine Habits (Operating System / No. of Machines)</li>
<li>Software Preferences/Expectations (if they already utilise a maintenance software, and/or what their expectations are)</li>
<li>Consumer behaviour (pricing)</li>
<li>Opinions (about the interface, or if they have any questions)</li>
</ul>
<br>
<p>The feedback from this survey will enable us to compare the critical assumptions we have made about our potential users against the real-world market.</p>
<p>The survey and ethics form required to complete market testing has been attached below.</p>
<br>
<p><a href="assets/docs/marketing/DocDuckMarketingPortfolio.pdf" target="_blank">Marketing Portfolio</a></p>
<p><a href="assets/docs/marketing/DocDuckMarketTestingQuestionnaire.pdf" target="_blank">Market Testing Questionnaire</a></p>
<p><a href="assets/docs/marketing/EthicsForm.pdf" target="_blank">Ethics Form</a></p>
<p>Our product analysis contains market research of our competitors, our Unique Selling Points (USPs), our target audience, and a SWOT analysis.</p>
<p>This document is essential for aligning our marketing strategies and the making of one coherent plan. It is still in its draft form, containing contributions from Noah, Hari, Luke, Jabez and Josh. </p>
<br>
<p>Our first draft can be found below:</p>
<br>
<p><a href="assets/docs/marketing/DocDuckMarketingPlan_Draft1.pdf" target="_blank">Marketing Plan Draft 1</a></p>
<p><a href="assets/docs/marketing/DocDuck_Marketing_Plan_Draft2.pdf" target="_blank">Marketing Plan Draft 2</a></p>
<p><a href="assets/docs/marketing/DocDuck_Marketing_Plan.pdf" target="_blank">Marketing Plan Draft 3</a></p>
<br>
<h2> Final Version</h2>
<p><a href="assets/docs/marketing/DocDuck%20Marketing%20Plan.pdf" target="_blank">DocDuck Marketing Plan</a></p>
</div>
<!-- SLIDE 6 -->
<div class="slide-conts" data-current="a6" data-next="a7" data-prev="a5">
<h1>Project Wide Standard</h1>
<br>
<p> The Project Wide Standard provides guidelines and rules to describe the expected elements in the XML documents to be interpreted by the software. It will be used to verify each piece of item content in a document, to assure it adheres to the description of the element it is placed in.</p>
<p>The project wide standard ensures consistency, maintainability, and collaboration accross the project.</p>
<br>
<p>The Project Wide Standard format we have decided to choose, is an XSD Schema. This is the simplest and cleanest method for providing the rules for XML files to follow.</p>
<br>
<!-- File needs adding into /assets/docs/ -->
<p><a href="assets/docs/pws/PWS-v1.0.xsd" target="_blank">Project Wide Standard Draft 1</a></p>
<p><a href="assets/docs/pws/PWS-v2.0.xsd" target="_blank">Project Wide Standard Draft 2</a></p>
<p><a href="assets/docs/pws/PWS-v3.0.xsd" target="_blank">Project Wide Standard Draft 3</a></p>
<p><a href="assets/docs/pws/PWS-v4.0-final.xsd" target="_blank">Project Wide Standard Release 1 (Final Version)</a></p>
<br>
<p>Additionally, we have developed our own schemas by extending the Project Wide Standard for the purposes of more advanced GUI control and data storage</p>
<br>
<p><a href="assets/docs/pws/DocDuckStandardSchema.xsd" target="_blank">Extended schema with additional GUI elements</a></p>
<p><a href="assets/docs/pws/DocDuckSchema.xsd" target="_blank">Extended schema with additional data elements for custom DocDuck Data</a></p>
</div>
<!-- SLIDE 7 -->
<div class="slide-conts" data-current="a7" data-next="a8" data-prev="a6">
<h1>Inter Group Contracts</h1>
<br>
<p>As part of the requirements to buy in at least two media handlers, 5 contracts have been agreed between DocDuck and
BookCook. DocDuck is buying from BookCook java librarries designed to diplay audio and video and selling them libraries to display graphics and text.
The contracts lay out what the buyer expects in terms of payment and delivery schedule as well as coding and functional specifications.</p>
<br>
<p>Links to the signed contracts have been provided below:</p>
<br>
<!-- File needs adding into /assets/docs/ -->
<p><a href="assets/docs/contracts/BookCook-Graphics-Contract-Signed.pdf" target="_blank">Graphics Handler Sale Contract</a></p>
<p><a href="assets/docs/contracts/BookCook-Text-Contract-Signed.pdf" target="_blank">Text Handler Sale Contract</a></p>
<p><a href="assets/docs/contracts/DocDuck-Audio-Contract-Signed.pdf" target="_blank">Audio Handler Purchase Contract</a></p>
<p><a href="assets/docs/contracts/DocDuck-Video-Contract-Signed.pdf" target="_blank">Video Handler Purchase Contract</a></p>
<br>
<p>An ammendment has been agreed between DocDuck and BoocCook to the Text Handler Contract to clarify the requiremtnes for input format of the library outlined below:</p>
<p><a href="assets/docs/contracts/Text_contract_amendment signed.pdf" target="_blank">Text Handler Sale Contract Amendment</a></p>
<br>
<p>An additional contract has also been agreed between DocDuck and BookCook after the initial contract period for the sale of an addition to the Text Library outside the bounds of the original contract:</p>
<p><a href="assets/docs/contracts/DocDuck_Text_Field_Contract.pdf" target="_blank">Text Input Handler Purchase Contract</a></p>
</div>
<!-- SLIDE 8 -->
<div class="slide-conts" data-current="a8" data-next="a9" data-prev="a7">
<h1>Meeting Minutes and Agendas</h1>
<br>
<p>Minutes are taken during meetings to document the discussions during, and actions to be undertaken after, each meeting. Meeting minutes are filled in during the meeting by a QA and Documentation Manager.
An agenda for each meeting is set before it by a Project Manager and available before each meeting for group members to familiarise themselves</p>
<br>
<p>Links to the minutes and agendas have been provided below:</p>
<br>
<!-- File needs adding into /assets/docs/ -->
<p><a href="assets/docs/minutes/September/" target="_blank">Meeting Minutes and Agendas - September 2023</a></p>
<p><a href="assets/docs/minutes/October/" target="_blank">Meeting Minutes and Agendas - October 2023</a></p>
<p><a href="assets/docs/minutes/November/" target="_blank">Meeting Minutes and Agendas - November 2023</a></p>
<p><a href="assets/docs/minutes/December/" target="_blank">Meeting Minutes and Agendas - December 2023</a></p>
<p><a href="assets/docs/minutes/January/" target="_blank">Meeting Minutes and Agendas - January 2024</a></p>
<p><a href="assets/docs/minutes/February/" target="_blank">Meeting Minutes and Agendas - February 2024</a></p>
<p><a href="assets/docs/minutes/March/" target="_blank">Meeting Minutes and Agendas - March 2024</a></p>
<p><a href="assets/docs/minutes/April/" target="_blank">Meeting Minutes and Agendas - April 2024</a></p>
<p><a href="assets/docs/minutes/May/" target="_blank">Meeting Minutes and Agendas - May 2024</a></p>
<p><a href="assets/docs/minutes/Templates/" target="_blank">Meeting Minutes and Agenda - Templates</a></p>
</div>
<!-- SLIDE 9 -->
<div class="slide-conts" data-current="a9" data-next="a10" data-prev="a8">
<h1>Timesheets</h1>
<br>
<p>To track individual progress, a weekly timesheet/report has been used. This contains information of which meetings the employee has attended, how long they have worked each week, and what work has been completed each week. The reports should be ratified by a QA and Documentation Manager each week.</p>
<br>
<!-- File needs adding into /assets/docs/ -->
<p><a href="assets/docs/reports/William/" target="_blank">Timesheets - William Betteridge</a></p>
<p><a href="assets/docs/reports/Josh/" target="_blank">Timesheets - Josh Bradley</a></p>
<p><a href="assets/docs/reports/Noah/" target="_blank">Timesheets - Noah Carter</a></p>
<p><a href="assets/docs/reports/Jabez/" target="_blank">Timesheets - Jabez Cheung</a></p>
<p><a href="assets/docs/reports/Zhihao/" target="_blank">Timesheets - Zhihao Ma</a></p>
<p><a href="assets/docs/reports/Hari/" target="_blank">Timesheets - Hari Mamman</a></p>
<p><a href="assets/docs/reports/James/" target="_blank">Timesheets - James Stevenson</a></p>
<p><a href="assets/docs/reports/Rob/" target="_blank">Timesheets - Rob Walker</a></p>
<p><a href="assets/docs/reports/Luke/" target="_blank">Timesheets - Luke Warbey</a></p>
</div>
<!-- SLIDE 10 GUI -->
<div class="slide-conts" data-current="a10" data-next="a11" data-prev="a9">
<h1>GUI Demos and Source code</h1>
<br>
<p> UX Designs with Figma and GUI Demo Designs with JavaFX and Gradle: On the left is a interactive login page for DocDuck and on the right is a UX design of a home page with scrollable text.</p>
<br>
<!-- Add in an image, the max-width defines the width the image spreads across the page -->
<!-- Add a link to the subfolder -->
<p><a href="assets/source-code/" target="_blank">Link to Source Code</a></p>
<br>
<img src="assets/img/DocDuck%20Login%20Java%20demo.png" style="max-width: 35%;" class="left" />
<img src="assets/img/DocDuck%20Home%20Page%20Figma.PNG" style="max-width: 50%;" class="right" />
</div>
<!-- SLIDE 11 GUI pt2-->
<div class="slide-conts" data-current="a11" data-next="a12" data-prev="a10">
<h1>HTML Mockup Examples</h1>
<br>
<p>HTML Mockup Examples of our software application, includes the original GUI Demo, Admin page, Machine information page, Machine status page and login page , Click the link and scroll on each side of design </p>
<br>
<p><a href="GraphicInterfaceHTMLMockup.html" target="_blank">Original GUI HTML Mockup</a></p>
<p><a href="assets/GUIHTMLAssets/Admin%20Page%20HTML/index.html" target="_blank"> Admin Page HTML Mockup </a></p>
<p><a href="assets/GUIHTMLAssets/Maintenance%20Report%20HTML/index.html" target="_blank"> Maintenance Report Page HTML Mockup </a></p>
<p><a href="assets/GUIHTMLAssets/Report%20Page%20HTML/index.html" target="_blank"> Machine Status Page HTML Mockup </a></p>
<p><a href="assets/GUIHTMLAssets/login%20page%20HTML/index.html" target="_blank"> Login Page HTML Mockup </a></p>
</div>
<!-- SLIDE 12 GUI pt3-->
<div class="slide-conts" data-current="a12" data-next="a13" data-prev="a11">
<h1>More GUI mockups</h1>
<br>
<p>Below are more mockup examples, On the left is a mockup example of the admin page and on the right is an example of the machine status overview page. </p>
<br>
<img src="assets/img/Admin%20Page.PNG" style ="max-width: 40%;" class="left" />
<img src="assets/img/Report%20Page.png" style ="max-width: 40%;" class="right" />
</div>
<!-- SLIDE 13 Testing -->
<div class="slide-conts" data-current="a13" data-next="a14" data-prev="a12">
<h1>TDD Example</h1>
<br>
<p> Provided below is a basic structure for the LoginSystem class and its corresponding test class LoginSystemTest in the following PDF file.</p>
<p> The second link is the Test & Integaration Plan</p>
<p> The thrid link is the test reports</p>
<br>
<p><a href="assets/docs/tdd/TDD_example.pdf" target="_blank">TDD Example for Login System</a></p>
<p><a href="assets/docs/tdd/DocDuck_TestingAndIntegration_Plan.pdf" target="_blank">Test & Integaration Plan</a></p>
<p><a href="assets/docs/tdd/TestReport/" target="_blank"> Test Reports</a></p>
</div>
<!-- SLIDE 14 Version Control -->
<div class="slide-conts" data-current="a14" data-next="a15" data-prev="a13">
<h1>Version Control Examples Within Project</h1>
<br>
<p> In our project we have an organisation on GitHub with multiple Repositories where we all contribute to documents from Overleaf (Latex), Java and HTML. .</p>
<br>
<p> On the Left is an example of Commits and Branches within out HTML tour and on the right is our Repositories for our project so far.</p>
<br>
<img src="assets/img/GitHubLog.PNG" style="max-width: 40%;" class="left" />
<img src="assets/img/GitHubReps.PNG" style="max-width: 40%;" class="right" />
</div>
<!-- SLIDE 15 Software Development -->
<div class="slide-conts" data-current="a15" data-next="a1" data-prev="a14">
<h1>Software Development</h1>
<br>
<p>To plan out all the software and assign tasks, we created an actively updated Gantt chart which between the Software Manager and Project Manager
was kept up to date throughout Semester 2.
</p>
<br>
<p>Additionally at the start of the software planning, to have a rough outline of the initial creation of software a TODO list with a priority assignment
was created. This was used in the first couple of weeks by the Software Manager to create a plan and organise the group.
</p>
<br>
<h3>Gantt Chart & Software Planning</h3>
<p><a href="gantt-chart/TODO.html" target="_blank">Initial TODO List</a></p>
<p><a href="gantt-chart/Software_Gantt_Chart.html" target="_blank">Software Gantt chart</a></p>
<br>
<p>Additional resources were written by the Software Manager for the rest of the group to refer to and reference as and when needed.
These are included below.
</p>
<br>
<p><a href="./assets/docs/software/Software_Development_Notes_and_FAQ.pdf" target="_blank">Software development notes and FAQ</a></p>
<p><a href="./assets/docs/software/Java_Formatting_Standards.pdf" target="_blank">Java formatting standards designed by the Software Manager for maintainable code</a></p>
</div>
<!-- ADD MORE SLIDES HERE AS REQUIRED -->
<!-- Copy and paste one of the slide examples above and edit it below -->
<!-- All slide information should be placed within the following div code (Uncomment the code below if using it) -->
<!-- <div class="slide-conts" data-current="a3" data-next="a1">
</div> -->
<!-- Buttons to go to next slide -->
<div class="slide-buttons">
<button onclick="prevSlide()">Previous Slide</button>
<button onclick="nextSlide()">Next Slide</button>
</div>
</div>
<!-- Javascript to handle the button presses -->
<script>
function nextSlide() {
// get list of all slides
const slides = document.querySelectorAll(".slide-conts");
// get current active slide and remove active id
const curr_slide = document.querySelector("#active");
curr_slide.id = "";
//get next slide with data-current == data-next
let next = curr_slide.dataset.next;
for ( let i = 0; i < slides.length; i++ )
{
if ( slides[i].dataset.current == next )
{
console.log("Switched to next slide");
slides[i].id="active";
}
}
}
function prevSlide()
{
// get list of all slides
const slides = document.querySelectorAll(".slide-conts");
// get current active slide and remove active id
const curr_slide = document.querySelector("#active");
curr_slide.id = "";
//get previous slide with data-current == data-prev
let prev = curr_slide.dataset.prev;
for (let i = 0; i < slides.length; i++)
{
if (slides[i].dataset.current == prev)
{
console.log("Switched to prev slide");
slides[i].id="active";
}
}
}
</script>
</body>
</html>