summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--iadocs/cover_page.htm10
1 files changed, 5 insertions, 5 deletions
diff --git a/iadocs/cover_page.htm b/iadocs/cover_page.htm
index 4ebb05a..3b85be8 100644
--- a/iadocs/cover_page.htm
+++ b/iadocs/cover_page.htm
@@ -12,6 +12,10 @@
-- So I took the CSS I use in the actual solution and removed some
-- bits, and there you have it...
-->
+<!--
+ -- NOTE (to self): This cover page is not included in the word count
+ -- and its functionality is not assessed.
+ -->
<html lang="en">
<head>
<title>Computer Science Solution Cover Page</title>
@@ -323,9 +327,6 @@ pre {
<p>
Users are advised to read the <a href="../docs/user_handbook.html">User Handbook</a>, although the system should be relatively intuitive to most users.
</p>
- <p>
- An additional <a href="../docs/developer_handbook.html">Developer Handbook</a> is available for future developers who wish to have a more nuanced understanding of the system&rsquo;s design than what Criterion B requires documenting.
- </p>
<h2>Links to Documentation for Assessment Criteria</h2>
<p style="color: var(--greyedout)">Note: The compiled PDF versions are currently not provided within the repository.</p>
<ul>
@@ -342,8 +343,7 @@ pre {
The word count of IB-required documentation is XXXX words.
</p>
<p>
- The handbooks contain additional documentation to assist using the solution in production. Documentation is a critical component of any computer solution.
- <strong style="color: red;">Should this count towards the documentation word count? If not, is the examiner allowed to read it? If not, should I create a &ldquo;concise&rdquo; version of the handbooks to be used during assessment? If so, where should I put it?</strong>
+ The handbooks contain additional documentation to assist using the solution in production. Although they are technically not part of the IA documentation as required by the IB, they may be helpful to people who wish to actually use or continue developing this project.
</p>
<p>
The source code itself is also thoroughly documented in the form of comments, for most non-trivial implementation detail.