Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@uo287545
uo287545 committed Feb 11, 2024
1 parent 12992a6 commit 1a00d65
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 112 deletions.
Binary file removed images/Deployment diagram.png
View file
Binary file not shown.
Binary file removed images/Technical Context Diagram.png
View file
Binary file not shown.
122 changes: 10 additions & 112 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -458,14 +458,7 @@ <h1><span class="image"><img src="./images/arc42-logo.png" alt="arc42"></span> T
<li><a href="#_technical_context">3.2. Technical Context</a></li>
</ul>
</li>
<li><a href="#section-solution-strategy">4. Solution Strategy</a>
<ul class="sectlevel2">
<li><a href="#_technological_decisions">4.1. Technological Decisions</a></li>
<li><a href="#_system_decomposition">4.2. System Decomposition</a></li>
<li><a href="#_quality_goals_2">4.3. Quality Goals</a></li>
<li><a href="#_organizational_decisions">4.4. Organizational Decisions</a></li>
</ul>
</li>
<li><a href="#section-solution-strategy">4. Solution Strategy</a></li>
<li><a href="#section-building-block-view">5. Building Block View</a>
<ul class="sectlevel2">
<li><a href="#_whitebox_overall_system">5.1. Whitebox Overall System</a></li>
Expand Down Expand Up @@ -914,17 +907,11 @@ <h3 id="_business_context">3.1. Business Context</h3>
</div>
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/Deployment%20diagram.png" alt="Deployment diagram" width="1029" height="578">
</div>
<div class="paragraph">
<p><strong>&lt;Diagram or Table&gt;</strong></p>
</div>
<div class="paragraph">
<p><strong>Explanation:</strong>
* <strong>User:</strong> Represents users who interact with the application to play games or view their history.
* <strong>System (QuestionGame):</strong> The main system that hosts the game logic and manages user interactions.
* <strong>WikiData:</strong> Component used to retrieve data from Wikidata and automatically generate questions.
* <strong>Database:</strong> Stores system information, such as user data, generated questions, game history, etc.</p>
<p><strong>&lt;optionally: Explanation of external domain interfaces&gt;</strong></p>
</div>
</div>
<div class="sect2">
Expand All @@ -946,81 +933,19 @@ <h3 id="_technical_context">3.2. Technical Context</h3>
</div>
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/Technical%20Context%20Diagram.png" alt="Technical Context Diagram" width="1043" height="578">
<div class="paragraph">
<p><strong>&lt;Diagram or Table&gt;</strong></p>
</div>
<div class="paragraph">
<p><strong>&lt;optionally: Explanation of technical interfaces&gt;</strong></p>
</div>
<div class="ulist">
<ul>
<li>
<p>User Agent: Represents the web or mobile interface used by users.</p>
</li>
<li>
<p>QuestionGame server: The server-side components, including the Frontend, QuestionGame logic, User&#8217;s API, and Question&#8217;s API.</p>
</li>
<li>
<p>HTTPS: Represents the communication channels, with HTTPS being the protocol used for secure communication.</p>
</li>
<li>
<p>Question Generation: Represents the means used for question and answers generation.</p>
</li>
<li>
<p>Database: Represents whichever system used for data persistence.</p>
</li>
<li>
<p>To be decided: Indicates that specific details about the channels and protocols are yet to be determined.</p>
</li>
</ul>
<div class="paragraph">
<p><strong>&lt;Mapping Input/Output to Channels&gt;</strong></p>
</div>
<div class="sect3">
<h4 id="_inputoutput_mapping_table">3.2.1. Input/Output Mapping Table</h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 40%;">
<col style="width: 40%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Component</th>
<th class="tableblock halign-left valign-top">Input/Output</th>
<th class="tableblock halign-left valign-top">Channel/Protocol</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">User&#8217;s API</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">User registration, game history</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPS</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Question&#8217;s API</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Question data retrieval</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPS</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Frontend</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">User interactions, game display</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPS</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Database</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">User data, game history, questions</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Specific database driver</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">WikiData</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data for question generation</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP</p></td>
</tr>
</tbody>
</table>
<div style="page-break-after: always;"></div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="section-solution-strategy">4. Solution Strategy</h2>
<div class="sectionbody">
Expand Down Expand Up @@ -1065,36 +990,9 @@ <h2 id="section-solution-strategy">4. Solution Strategy</h2>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_technological_decisions">4.1. Technological Decisions</h3>
<div class="paragraph">
<p>Programming Language: [Language] will be used for system development due to [reasons].
Frontend Framework: [Framework] will be adopted for frontend development due to [reasons].
Database: [Database] was selected as the storage engine due to [reasons].</p>
</div>
</div>
<div class="sect2">
<h3 id="_system_decomposition">4.2. System Decomposition</h3>
<div class="paragraph">
<p>The [pattern] architecture pattern will be followed for structuring the system, dividing it into modules/classes responsible for [responsibilities].</p>
</div>
</div>
<div class="sect2">
<h3 id="_quality_goals_2">4.3. Quality Goals</h3>
<div class="paragraph">
<p>Performance: A quick system response will be sought, especially during question generation and gameplay.
Security: Security measures will be implemented to protect user information and ensure the integrity of generated questions.</p>
</div>
</div>
<div class="sect2">
<h3 id="_organizational_decisions">4.4. Organizational Decisions</h3>
<div class="paragraph">
<p>Development Methodology: [Methodology] will be adopted for project management, facilitating collaboration and iterative delivery.</p>
</div>
<div style="page-break-after: always;"></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="section-building-block-view">5. Building Block View</h2>
<div class="sectionbody">
Expand Down

0 comments on commit 1a00d65

Please sign in to comment.