Skip to content

Commit

Permalink
Updated documentation asks to be mor close aligned with LOs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrbrianojee authored Aug 4, 2024
1 parent 4cf8f54 commit b6b87a7
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions HTML-CSS-Project-1-Implementati0on-Guide-Dynamic.html
Original file line number Diff line number Diff line change
Expand Up @@ -268,17 +268,19 @@ <h3>Environment Setup and Version Control (1 hour)</h3>
<li>Document the setup process in the README (Setup and Installation section).</li>
</ul>
</li>
<li><strong>Associated Criteria:</strong> LO3.2, LO4.6, LO4.9</li>
<li><strong>Associated Criteria:</strong> LO3.2, LO4.6, LO4.9, LO5.1</li>
<li><strong>Pass Grade: Expected Pass Performance (Do's):</strong>
<ul>
<li>Commit regularly to GitHub with meaningful commit messages.</li>
<li>Organize files logically from the start.</li>
<li>Use consistent and effective markdown formatting to produce a README file in English that is well-structured, easy to follow, and has few grammatical errors. (LO5.1)</li>
</ul>
</li>
<li><strong>Pass Grade Areas for Improvement (Don'ts):</strong>
<ul>
<li>Delay setting up version control.</li>
<li>Forget to test the setup to ensure everything is working correctly.</li>
<li>Produce a README file with inconsistent formatting or grammatical errors. (LO5.1)</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -376,6 +378,7 @@ <h3>Must User Stories Implementation (10 hours)</h3>
<li>Design must meet accessibility guidelines and have good contrast. (LO1.1)</li>
<li>Ensure clear organization of information with headers and prioritized content. (LO1.3)</li>
<li>Provide comprehensive documentation of key coding decisions and challenges. (LO2.1, LO4.1)</li>
<li>Document any bugs found and their fixes and explanation of any bugs that are left unfixed. (LO2.1)</li>
</ul>
</li>
<li><strong>Merit Grade Areas for Improvement (Don'ts):</strong>
Expand All @@ -398,6 +401,7 @@ <h3>Must User Stories Implementation (10 hours)</h3>
<li>Provide comprehensive documentation of key coding decisions and challenges. (Comments)</li>
<li>Ensure all code is well-structured and adheres to best practices. (Clean Code)</li>
<li>Provide a thorough testing report with documented issues and resolutions. (Compliant Code)</li>
<li>The solution’s purpose is documented: The purpose of the application is clearly described in the README - key project goals, target audience, screenshots (Real-world application)</li>
</ul>
</li>
<li><strong>Distinction Grade Areas for Improvement (Don'ts):</strong>
Expand Down Expand Up @@ -640,6 +644,7 @@ <h3>Documentation (2 hours)</h3>
<ul>
<li>Provide detailed documentation for complex code sections, explaining the choices made and any challenges encountered. (LO4.1, LO4.2)</li>
<li>Ensure the README covers all aspects of the project comprehensively. (LO4.3)</li>
<li>Document any bugs found and their fixes and explanation of any bugs that are left unfixed. (LO2.1)</li>
</ul>
</li>
<li><strong>Merit Grade Areas for Improvement (Don'ts):</strong>
Expand All @@ -651,12 +656,13 @@ <h3>Documentation (2 hours)</h3>
</div>

<button class="accordion">Show Distinction Guidance</button>
<div class="panel">
<div class "panel">
<li><strong>Distinction Grade: Expected Performance (Do's):</strong>
<ul>
<li>Provide detailed documentation for complex code sections, explaining the choices made and any challenges encountered. (Comments)</li>
<li>Ensure the README covers all aspects of the project comprehensively. (Readability)</li>
<li>The documentation demonstrates a high level of professionalism and attention to detail. (Real-world application)</li>
<li>The solution’s purpose is documented: The purpose of the application is clearly described in the README - key project goals, target audience, screenshots (Real-world application)</li>
</ul>
</li>
<li><strong>Distinction Grade Areas for Improvement (Don'ts):</strong>
Expand Down

0 comments on commit b6b87a7

Please sign in to comment.