Reportdesign
Описание
Правила оформления лабораторных работ
Все отчеты по лабораторным работам будут приниматься в формате github репозиториев, где название репозитория отражает следующую информацию: учебный год проведения курса, название курса, номер группы, фамилия, имя и отчетство.
Например: 2023_2024-introduction_to_distributed_technologies-k66666-filianin_i_v
Зачем это нужно? Мы планируем по окончанию курса сохранить результаты ваших работ в данном репозитории, для истории и для того чтобы следующие потоки студентов могли брать опыт из ваших работ если это потребуется.
В самом репозитории вы создаете следующие файлы:
- .gitignore (в вашем репозитории не должно быть служебного мусора)
- README.md (в нем должно содержаться описание вашего репозитория, интересные замечания по деятельности и т.д)
- LICENSE (вы можете выбрать любую понравившуюся вам лицензию)
Также вам необходимо создать папки с названием lab1, lab2 и т.д по количеству лабораторных работ. В каждой папке вы создаете файл lab1_report.md, lab2_report.md и т.д в соответствующих папках. В самих файлах, в шапке у вас должна быть следующая информация:
University: [ITMO University](https://itmo.ru/ru/)
Faculty: [FICT](https://fict.itmo.ru)
Course: [Introduction to distributed technologies](https://github.com/itmo-ict-faculty/introduction-to-distributed-technologies)
Year: 2023/2024
Group: K66666
Author: Filianin Ivan Victorovich
Lab: Lab1
Date of create: 20.09.2023
Date of finished: 31.09.2023
Важно понимать, что "Date of create:" это дата начала работы над лабораторной работой, а "Date of finished:" это дата когда вы защитили своб лабораторную работу перед преподавателем.
Остальное содержание отчета остается на ваше усмотрение, но важно понимать что чем подробнее и понятнее вы напишите свой отчет, тем проще вам будет его защитить.
Процесс сдачи лабораторной работы
Как только вы будете готовы к сдаче лабораторной работы, вам необходимо на паре которая в расписании относится к лабораторным сообщить преподавателю практики о том что вы готовы защищать свою лабораторную работу. Вы должны показать преподавателю на своем компьютере отчет по лабораторной работе и ответить на дополнительные вопросы. Каждая лабораторная работа может оцениваться от 0 до 100%.
Весь ваш прогресс будет записываться в данную табличку ссылка.
Правила оформления отчёта по курсу "Разработка и размещение технической статьи на Medium или Habr"
Для отчета по данному курсу вам необходимо создать папку popular_article
в ранее созданном репозитории и разместить в ней краткое описание статьи в файле report.md
с ссылкой на вашу статью.
В файле report.md
должна быть следующая структура:
- Название статьи
- Ссылка на статью
- Ключевые слова
- Аннотация
Если в ходе работы у вас были черновики/наработки, вы также можете сложить их в папку popular_article
. Это поможет преподавателю оценить ход вашей работы.
Description
Rules for Completing Laboratory Works
All reports on laboratory works will be accepted in the format of GitHub repositories, where the repository name reflects the following information: the academic year of the course, the course name, the group number, last name, first name, and patronymic.
For example: 2023_2024-introduction_to_distributed_technologies-k66666-filianin_i_v
Why is this necessary? We plan to save the results of your work in this repository at the end of the course, for historical purposes and so that future groups of students can draw from your work if it is needed.
In the repository itself, you should create the following files:
- .gitignore (your repository should not contain any unnecessary files)
- README.md (it should contain a description of your repository, interesting notes about your work, etc.)
- LICENSE (you can choose any license you like)
You also need to create folders named lab1, lab2, and so on, for each laboratory work. In each folder, you create a file named lab1_report.md, lab2_report.md, and so on, in the corresponding folders. In the files themselves, the header should contain the following information:
University: [ITMO University](https://itmo.ru/ru/)
Faculty: [FICT](https://fict.itmo.ru)
Course: [Introduction to distributed technologies](https://github.com/itmo-ict-faculty/introduction-to-distributed-technologies)
Year: 2023/2024
Group: K66666
Author: Filianin Ivan Victorovich
Lab: Lab1
Date of create: 20.09.2023
Date of finished: 31.09.2023
It's important to understand that "Date of create:" is the date when you started working on the laboratory work, and "Date of finished:" is the date when you defended your laboratory work to the teacher.
The rest of the content of the report is up to you, but it's important to understand that the more detailed and clear your report is, the easier it will be to defend it.
Laboratory Work Submission Process
Once you are ready to submit a laboratory work, you need to inform the practice teacher during the class that is scheduled for laboratory work. You must show the practice teacher your report on the laboratory work on your computer and answer any additional questions. Each laboratory work can be graded from 0 to 100%.
Your progress will be recorded in this spreadsheet link.
Rules for Writing a Report for the Course "Development and Posting of a Technical Article on Medium or Habr"
To submit a report for this course, you need to create a popular_article folder in the previously created repository and place a brief description of the article in the report.md file with a link to your article.
The report.md file should have the following structure:
- Article Title
- Link to the article
- Keywords
- Abstract
If you had drafts or notes during your work, you can also place them in the popular_article folder. This will help the teacher assess the progress of your work.