To ensure the proper planning and execution of the ASIR 2nd year intermodular project, technical documentation must be prepared that covers all key aspects of the design:
Project report: In previous years, this was done in a notebook, but this year it can be submitted in PDF format on a USB stick. This document will cover the entire project process, from the initial idea to the final conclusions.
Structure: The documentation must be organised on the basis of network diagrams, system diagrams, service definitions, and an orderly description of the steps taken during the development of the project.
Installation manual: A clear guide will be included with all the steps necessary to install and configure the system, indicating prerequisites, commands used, and basic checks.
Explanation of the commands used: It is important to detail each command executed, explaining its function, where it is used in the process, and what result is expected. This demonstrates technical understanding and facilitates the reproduction of the system by third parties.
Validation of the development: Functional tests of the system will be carried out to check that everything is working correctly. Screenshots, test logs, and a brief final assessment with possible improvements should be included.