commit 7bb1dd6a905dfa2fe07b56fd6345214cb75e792c Author: Moscow Polytech Date: Mon Mar 31 12:14:02 2025 +0300 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..e378a82 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Проектная (учебная) практика + +## Участники + +| ФИО | Учебная группа | Код направления подготовки | Профиль образовательной программы | +|-|-|-|-| +| ФИО1 |||| +| ФИО2 |||| +| ФИО3 |||| + +## Задание + +Задание размещено в папке **task** в файле [README.md](task/README.md). + +## Вариативная часть задания + +Формулировка задания вариативной части и выбранная тематика (если есть). Приведите также дополнительные ссылки на источники задания (если есть). + +## Ответственный по проектной (учебной) практике + +ФИО ответственного, кафедра. + +## Проектная деятельность + +Проектная (учебная) практика проводилась в связке с выполнением проекта «***Наименование проекта***» по дисциплине «Проектная деятельность». + +ФИО куратора по проектной деятельности. + +## Период проведения + +С 03 февраля 2025 г. по 24 мая 2025 г. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..ee16ad7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +# Документация + +- Папка для размещения документации по практике в формате Markdown. +- README.md — основной файл с документацией, описывающий процесс выполнения практики. +- При необходимости могут добавляться дополнительные файлы Markdown. diff --git a/reports/README.md b/reports/README.md new file mode 100644 index 0000000..0746563 --- /dev/null +++ b/reports/README.md @@ -0,0 +1,5 @@ +# Отчёты в бинарных форматах + +- В этот файл добавьте ссылки на файлы отчётов и краткое описание к ним. +- Файлы могут быть в форматах DOCX, PDF и др. +- Структура отчёта по проектной практике приведена в файле [practice_report_template.docx](practice_report_template.docx). diff --git a/reports/practice_report_template.docx b/reports/practice_report_template.docx new file mode 100644 index 0000000..7ab2f1a Binary files /dev/null and b/reports/practice_report_template.docx differ diff --git a/site/index.html b/site/index.html new file mode 100644 index 0000000..e69de29 diff --git a/task/README.md b/task/README.md new file mode 100644 index 0000000..0f7da20 --- /dev/null +++ b/task/README.md @@ -0,0 +1,150 @@ +# Проектная практика + +## Задание на проектную практику + +### Введение + +Задание на проектную (учебную) практику разработано для студентов первого курса, обучающихся по направлениям подготовки, связанным с информационными технологиями и информационной безопасностью. Трудоёмкость практики составляет 72 академических часа. Задание может выполняться **индивидуально** или **в составе группы до 3 человек**. Для управления версиями будет использоваться Git, для написания документации — Markdown, а для создания статического веб-сайта — языки разметки HTML и CSS, но опционально допускается использовать генераторы статических сайтов, такие, как Hugo. В качестве платформы для размещения репозиториев допустимо использовать как [GitHub](https://github.com/), так и [GitVerse](https://gitverse.ru/), что обеспечивает гибкость в выборе инструментов. Также предусмотрено взаимодействие с организациями-партнёрами, включая стажировки, которые будут приниматься к зачёту при оценке. + +Задание состоит из двух частей. Первая часть является общей и обязательной для всех студентов. Вторая часть вариативная. Задание на вторую часть может быть получено от: + +- ответственного за проектную (учебную) практику на выпускающей кафедре; +- куратора проекта по «Проектной деятельности», но должно быть согласовано с ответственным за проектную (учебную) практику на выпускающей кафедре. + +--- + +### 1. Базовая часть задания + +1. **Настройка Git и репозитория:** + - Создайте личный или групповой репозиторий на [GitHub](https://github.com/) или [GitVerse](https://gitverse.ru/) на основе предоставленного [шаблона](https://github.com/mospol/practice-2025-1). + - Освойте базовые команды Git: клонирование, коммит, пуш и создание веток. + - Регулярно фиксируйте изменения с осмысленными сообщениями к коммитам. + - **Ожидаемое время:** 5 часов. + +2. **Написание документов в Markdown:** + - Все материалы проекта (описание, журнал прогресса и др.) должны быть оформлены в формате Markdown. + - Изучите синтаксис Markdown и подготовьте необходимые документы. + - **Ожидаемое время:** 5 часов. + +3. **Создание статического веб-сайта:** + - Вы можете использовать **только HTML и CSS** для создания сайта, если освоение более сложных инструментов представляется трудным. Это делает задание доступным для студентов с базовым уровнем подготовки. + - **Желательно** применять генераторы статических сайтов, такие как Hugo (рекомендуется), для упрощения процесса и получения дополнительных навыков. В случае выбора Hugo можно воспользоваться инструкциями из [Hugo Quick Start Guide](https://gohugo.io/getting-started/quick-start/). + - Создайте новый сайт об основном проекте по дисциплине «Проектная деятельность», выберите тему и добавьте контент. Оформление и наполнение сайта должны быть уникальными (не совпадать с работами других студентов) более, чем на 50%. + - Сайт должен включать: + - **Домашнюю страницу** с аннотацией проекта. + - **Страницу «О проекте»** с описанием проекта. + - **Страницу или раздел «Участники»** с описанием личного вклада каждого участника группы в проект по «Проектной деятельности». + - **Страницу или раздел «Журнал»** с минимум тремя постами (новостями, блоками) о прогрессе работы. + - **Страницу «Ресурсы»** со ссылками на полезные материалы (ссылки на организацию-партнёра, сайты и статьи, позволяющие лучше понять суть проекта). + - Оформите страницы сайта графическими материалами (фотографиями, схемами, диаграммами, иллюстрациями) и другой медиа информацией (видео). + - **Ожидаемое время:** изучение и настройка — 10–14 часов, дизайн и наполнение — 4–8 часов. + +4. **Взаимодействие с организацией-партнёром:** + - Организуйте взаимодействие с партнёрской организацией (визит, онлайн-встреча или стажировка). + - Участвуйте в профильных мероприятиях по тематике проекта и профилю организации-партнёра (конференции, выставки, митапы, семинары, хакатоны и др.). + - **Уточнение:** Взаимодействие осуществляется через куратора проекта по проектной деятельности, закреплённого за вашим проектом, и ответственного по проектной практике, закреплённого за учебной группой. + - Напишите отчёт в формате Markdown с описанием опыта, полученных знаний и связи с проектом. Отчёт добавьте в репозиторий и на сайт. + - **Важно:** Стажировки и экскурсии в организации-партнёры будут приниматься к зачёту и учитываться при оценке, что мотивирует к активному участию. + - **Ожидаемое время:** взаимодействие — 4 часа, написание отчёта — 4 часа. + +5. **Отчёт по практике** + - Составьте отчёт по проектной (учебной) практике на основании шаблона (структуры), размещённого в папке reports. Шаблон (структура) приведён в файле [practice_report_template.docx](reports/practice_report_template.docx). + - Разместите отчёт в репозитории в папке reports с именем «Отчёт.docx» или «report.docx». + - Сформируйте PDF-версию отчёта и также разместите её в папке reports в репозитории. + - Загрузите оба файла отчёта (DOCX и PDF) в СДО (LMS) в курсе, который будет указан ответственным за проектную (учебную) практику. + +--- + +### 2. Вариативная часть задания + +По решению ответственного за проектную (учебную) практику студентам назначается одно из следующих вариативных заданий. Студенты могут направить ответственному свои пожелания по распределению. + +#### 1. Кафедральное индивидуальное отдельное задание + +- Выполните все задачи базовой части. +- Выполните кафедральное индивидуальное отдельное задание. +- Интегрируйте результаты индивидуального задания и отчёт по нему в репозиторий и сайт, созданные в базовой части. +- **Ожидаемое время:** 32–40 часов. + +--- + +#### 2. Практическая реализация технологии + +- Выполните все задачи базовой части. +- Для достижения объёма в 72 часа выберите один из следующих проектов: + +1. Выберите любую технологию (тематику) из списка, представленного в репозитории [codecrafters-io/build-your-own-x](https://github.com/codecrafters-io/build-your-own-x). По согласованию с ответственными за практику можно использовать другой источник проектов. +2. Согласуйте внутри команды выбранную тему. Выберите стек технологий (подсказки также есть в репозитории). +3. Проведите исследование: изучите, как создать выбранную технологию с нуля, воспроизведите практическую часть. +4. Создайте подробное описание в формате Markdown, включающее: + - Последовательность действий по исследованию предметной области и созданию технологии. + - Напишите техническое руководство по созданию этой технологии, ориентированное на начинающих. + - Включите в руководство: + - Пошаговые инструкции. + - Примеры кода. + - Иллюстрации (картинки, диаграммы, схемы) в количестве от 3 до 10 штук, вставленные в текст для наглядности. + - Поместите результаты исследования и руководства в общий Git-репозиторий. +5. Создайте техническое руководство или туториал по созданию проекта на выбранную тему. Для визуализации архитектуры, процессов и прочего используйте разные типы диаграмм UML, схемы, графики, таблицы. +6. Сделайте модификацию проекта согласно полученным знаниям и навыкам в течение года (творческий пункт, самостоятельно выбираете в какой части модифицировать). Описать в технической документации модификации. +7. Сделайте видео презентацию выполненной работы (цель, задачи, как решали, демонстрация работоспособного результата). +8. Задокументируйте проект в репозитории в формате Markdown и представьте его на сайте в формате HTML. +9. Подготовить финальный отчет (в хронологической последовательности опишите этапы работы, отдельно должны быть представлены индивидуальные планы каждого участника). + +- **Пример 1:** + - Для технологии «собственный интерпретатор» опишите этапы изучения синтаксиса, парсинга и выполнения кода, добавив схему работы интерпретатора и примеры кода. + +- **Пример 2:** + - Для технологии «собственный HTTP-сервер» создайте руководство с шагами по настройке сокетов, обработке запросов и отправке ответов, дополнив текст схемой взаимодействия клиент-сервер. + +- **Ожидаемое время:** 32–40 часов. + +#### 3. Вклад в открытый проект на GitHub или GitVerse + +- Выполните все задачи базовой части. +- Найдите открытый проект на GitHub или GitVerse, имеющий не менее 50 звёзд (Stars), изучите его код и внесите вклад (например, исправьте баг или добавьте новую функцию). +- Документируйте свой вклад в Markdown и добавьте описание в репозиторий. +- **Ожидаемое время:** 32–40 часов. + +--- + +### Структура git-репозитория + +В рамках практики следует придерживаться заданной структуры git-репозитория, приведённой в файле [git_structure.md](git_structure.md). + +--- + +### Контрольные сроки + +Сроки контрольных мероприятий приведены в файле [terms.md](terms.md). + +--- + +### Литература и интернет-ресурсы + +1. Введение в CSS верстку: + https://developer.mozilla.org/ru/docs/Learn_web_development/Core/CSS_layout/Introduction +2. DevTools для «чайников»: + https://habr.com/ru/articles/548898/ +3. Элементы HTML: + https://developer.mozilla.org/ru/docs/Web/HTML/Element +4. Основы HTML: + https://developer.mozilla.org/ru/docs/Learn_web_development/Getting_started/Your_first_website/Creating_the_content +5. Основы CSS: + https://developer.mozilla.org/ru/docs/Web/CSS +6. https://doka.guide/ +7. Официальная документация Git: + https://git-scm.com/book/ru/v2 +8. https://skillbox.ru/media/code/chto_takoe_git_obyasnyaem_na_skhemakh/ +9. Бесплатный курс на Hexlet по Git: + https://ru.hexlet.io/courses/intro_to_git +10. Уроки по Markdown: + https://ru.hexlet.io/lesson_filters/markdown + +--- + +### Информация для сведения + +- Общие задачи занимают 32–40 часов, дополнительные проекты добавляют 32–40 часов, что в сумме соответствует 72 часам. +- Выбор между индивидуальной и групповой работой (до 3 человек) позволяет адаптировать задание под ваши предпочтения. +- Возможность использовать как GitHub, так и GitVerse обеспечивает гибкость и доступ к современным инструментам. +- Исследовательские проекты и технические руководства, основанные на технологиях из [codecrafters-io/build-your-own-x](https://github.com/codecrafters-io/build-your-own-x), помогут развить навыки анализа, программирования и документирования. diff --git a/task/git_structure.md b/task/git_structure.md new file mode 100644 index 0000000..1d7e00c --- /dev/null +++ b/task/git_structure.md @@ -0,0 +1,81 @@ +# Структура git-репозитория + +Следует придерживаться предложенной структуры git-репозитория. При необходимости допускается создавать дополнительные папки верхнего уровня. + +## Файловая структура git-репозитория + +```plaintext +/ +├── README.md +├── docs/ +│ ├── README.md +│ ├── practice_documentation.md +│ └── ... +├── reports/ +│ ├── README.md +│ ├── report.pdf +│ └── ... +├── site/ +│ ├── index.html +│ ├── css/ +│ │ └── style.css +│ └── images/ +│ └── logo.png +├── src/ +│ ├── main.py +│ └── ... +├── task/ +│ ├── README.md +│ └── report_template.md +└── .gitignore +``` + +## Описание структуры git-репозитория + +1. **README.md** + Файл, расположенный в корне репозитория, содержит основную информацию о проекте: + - Наименование практики. + - Период проведения. + - Участники (ФИО). + - ФИО ответственного по проектной (учебной) практике. + - Наименование проекта по «Проектной деятельности». + - ФИО куратора по проектной деятельности. + - Формулировка задания вариативной части. + Этот файл служит точкой входа для всех, кто работает с репозиторием. + +2. **docs/** + Папка для размещения документации по практике в формате Markdown: + - **README.md** — основной файл с документацией, описывающий процесс выполнения практики. + - При необходимости могут добавляться дополнительные файлы Markdown. + +3. **reports/** + Папка для хранения бинарных файлов отчётов: + - **report.pdf** — пример итогового отчёта в формате PDF. + - Возможны другие форматы (например, DOCX), если это требуется. + +4. **site/** + Папка для статического сайта со всеми его ресурсами: + - **index.html** — главная страница сайта. + - **css/** — подпапка для файлов стилей: + - **style.css** — пример файла стилей. + - **images/** — подпапка для изображений: + - **logo.png** — пример изображения (логотип или другая графика). + Эта папка полностью изолирует ресурсы сайта от остальной части проекта. + +5. **src/** + Папка для исходного кода, создаваемого в рамках вариативного задания: + - **main.py** — пример файла с кодом (например, на Python). + - Структура внутри папки может расширяться в зависимости от нужд проекта (дополнительные файлы или подпапки). + +6. **task/** + Папка предназначена для хранения текста задания и шаблона отчёта: + - **README.md** — полный текст задания в формате Markdown. + - **report_template.md** — шаблон отчёта, который участники могут использовать для подготовки итоговых документов. + +7. **.gitignore** + Файл в корне репозитория, используемый для исключения из коммитов временных файлов, кэшей или других ненужных данных (например, `__pycache__`, `*.log`). + +## Преимущества структуры + +- **Чёткое разделение:** Каждая папка отвечает за свою задачу, что упрощает навигацию и управление проектом. Все элементы (README, задание, документация, отчёты, код, сайт) имеют свои места в репозитории. +- **Гибкость:** Структура позволяет легко добавлять новые файлы в соответствующие разделы (например, дополнительные отчёты или код). diff --git a/task/terms.md b/task/terms.md new file mode 100644 index 0000000..393b07b --- /dev/null +++ b/task/terms.md @@ -0,0 +1,10 @@ +# Контрольные сроки + +| Срок | Вид контроля | +| ---------- | ------------ | +| 31.03.2025 и 02.04.2025 | Решение о единоличном или групповом выполнении практики. | +| 31.03.2025 и 02.04.2025 | Согласование варианта вариативной части задания с ответственным за проектную (учебную) практику на выпускающей кафедре и куратором проекта по «Проектной деятельности». | +| 07.04.2025 и 09.04.2025 | Клонирование git-репозитория. Обеспечение доступа к репозиторию ответственному за проектную (учебную) практику и куратору проекта по «Проектной деятельности». | +| 21.04.2025 и 23.04.2025 | Демонстрация текущей версии сайта и вариативной части задания. На сайте необходимо разместить одну или две страницы о ходе выполнения проекта по проектной деятельности | +| 14.05.2025 и 16.05.2025 | Демонстрация полного выполнения всех частей задания. Получение обратной связи и задач для корректировки недочётов. | +| 19.05.2025 и 21.05.2025 | Аттестация по проектной (учебной) практике. Загрузка в СДО (LMS) отчёта по проектной практике. |