How to document a student/PHD project

Below is the standard format for how students and professors should document their project for the interaction lab. The language currently used is DocuWiki markdown syntax, though this is subject to change.

To get started

• Please contact the lab admin to start your documentation journey

Note: Work in Progress

Interaction-lab-eemcs@utwente.nl

Version/Date:

Provide a brief introduction to the project, its goals, and objectives.

List the hardware, software, and any other necessary resources required to complete the project.

• Hardware:
• Software:

Provide a brief or detailed overview of how the project was made, how did interaction lab contribute ?

Provide step-by-step instructions on how to set up and use the project. Include any troubleshooting tips or common issues that might arise.

1. Step 1
2. Step 2
3. Step 3
   • Additional notes or sub-steps if necessary

Note: Add notes for specific instructions, such as searching folders or finding buttons.

Include screenshots of the project in action, highlighting its key features and functionalities.

Screenshot 1 <!– Replace screenshot1_url with the actual URL of your screenshot –> Screenshot 2 <!– Replace screenshot2_url with the actual URL of your screenshot –>

Include a link to the GitHub repository where the code for the project is stored. Provide instructions on how to access and modify the code.

• GitHub Repository <!– Replace with the actual repository URL –>

Note: Explain any unusual code or code requirements here.

Wrap up the documentation with a summary of the project, its outcomes, and any future directions or improvements that could be made.

Include proper IEEE format attribution for any resources used in the project, such as images, code snippets, and other assets.

• Resource 1: Briefly describe the resource.
• Resource 2: Briefly describe the resource.

—

Interaction Lab