Стандартизація та документування програмних систем 2023
Topic outline
-
-
Савіцький Роман
Telegram @RomanSavitskyi
gitlab @Savitskyi
github roman-savitskyi
bitbucket Roman.Savitskyi@infopulse.com -
Відеозапис тут
Інформація про структуру курсу, спілкування, взаємодію, лекційні та практичні заняття
-
Ваш варіант на лабораторні роботи.
Варіант не розповсюджується на потік проектів -
Посилання на чат тут
-
-
-
Відеозапис тут
На лекції розібрали види та типи ліцензій, останні судові позови, FOSS спільноту, як краще і більш вірно працювати з ліцензіями -
Документування та ліцензування проектів
Відео тут -
-
Розглянули IEEE, ISO консорсіуми, ознайомились з принципами ISO 9001, переглянули на схематичне розподілення процесів та ресурсів в ISO 9001
Відеозапис неякісний.
Відеозапис 2023 року тут -
-
-
Все, що було у Вегасі, залишається у Вегасі.
-
Очікуємо на матеріали від АНдрія Концидайло
-
Розібрались з базовими теоретичними моментами, взнали про програми взаємодії Житомирської політехніки, відвідали інноваційний хаб
Український фонд стартапів ось їх телеграм канал з можливостями - https://t.me/usfofficial -
Юрій Годлевський зробив огляд готових рішень, а також АПІ та розповів, як створювати свої моделі і навіщо.
-
-
-
Необхідно знайти проект з відкритим кодом відповідно до ліцензії. Ваша ліцензія відповідає номеру варіанту. Після чого вам необхідно зробити fork (власну версію) проекту. Встановити пакет перевірки ліцензії (licence-checker) чи будь-який інший на ваш смак.
Після чого перевірити чи всі ліцензії пакетів відповідають ліцензії проекту. Роботу здаємо, як текстовий файл.Якщо пакет не працює на віндовз, виконати команду
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser в павершелі.
Текстовий файл містить:
1) Посилання на репо
2) JSON чи CSV згенерований licence-checker
3) Інформація чи вірно вибрана ліцензія, аргументація, якщо не вірно.
4) Інформація чи правильно прописана ліцензія в проекті.
Оцінювання
Licence-checker - 5
Вірна ліцензія + аргументування - 5
Вірно прописана ліцензія - 5
Штраф
Несвоєчасна здача -3 бали після 15.03
Несвоєчасна здача після екзамену -5 балів
Плагіат лабораторної 0 балів та додатково -15 балів від загальної оцінки.
Варіанти
1 ISC
2 MIT
3 Apache 2.0
4 GNU GPL
5 GNU LGPL
6 BSD-3-Clause
7 OSL-3.0 або python-2-0
8 BSD-3-Clause
9 Mozilla Public License 2.0
10 Common Development and Distribution License 1.0
11 Eclipse Public License version 2.0
12 SimPL-2.0
13 NPOSL-3.0
14 0BSD
15 BSD-2-Clause -
Виконати завдання в залежності від варіанту.
Описати в документі (декілька сторінок тезисно), пояснити і захистити очно під час практик.Теми відповідно до варіанту
1) IEEE. Які стандарти підходять ІПЗ та як їх імплементувати в процесах роботи та ПЗ.
2) iso. Розібратись і пояснити, хто такі мембери і як відбувається сертифікація ISO.
3) ISO. Стандарт 9001, основні цілі, розділи, на що звертається увага.
4) ISO. Стандарт 27001, основні цілі, розділи, на що звертається увага.
5) IEC. За що відповідає і як працює IEC (МЕК).
6) ДСТУ ISO/IEC TR 9126. Про що, як, навіщо, особливості.
7) ДСТУ ISO/IEC 14598. Про що, як, навіщо, особливості.
8) ДСТУ ISO/IEC 15939. Про що, як, навіщо, особливості.
9) Створити EULA для сайту https://ztu.edu.ua/
10) Створити Terms of Use для сайту https://ztu.edu.ua/
11) Створити Privacy & Policy для сайту https://ztu.edu.ua/
12) Створити опис по GDPR для сайту https://ztu.edu.ua/
13) Проаналізувати, які права використовуються по GDPR для сайту https://ztu.edu.ua/
14) Проаналізувати, які права використовуються по GDPR для сайту https://cabinet.ztu.edu.ua/
15) Створити опис по GDPR для сайту https://vstup.ztu.edu.ua/Оцінка
- Вірно складений документ з персональними висновками - 5 балів
- Доповідь по документу - 5 балів
- Відповідь на запитання - 5 балів
Загалом 15 балівШтрафи
Несвоєчасність після 10.04 -1 бал
Несвоєчасність після екзамену -2 бали -
-
Створити тему дипломної роботи, визначити мету, завдання, предмет, обʼєкт, актуальність, практичне значення, проаналізувати аналоги (2-3) та визначити потенційний стек проєкту з аргументацією вибору, відповідність 121 спеціальності. Документ повинен розкривати в цілому, ідею проекту. Може містити декілька сторінок. Обмежень по обʼєму немає
Альтернативний варіант:
Сформувати документ на основі однієї з моделей АІ використовуючи АПІ (посилання на ваш гіт). Або покрити одну з частин: документація, проект, презентація, можливо доповідьОцінювання
Формулювання теми - 2
Визначення мети та завдання - 3
Предмет, Обʼєкт - 2
Актуальність - 3
Практичне значення - 1
Аналоги - 2
Потенційний стек - 2
[бонус] АІ генерація - 15Загальна оцінка 15 балів
Штрафи
Несвоєчасна здача після 25.04 -2 бал
Несвоєчасна здача після екзамену - 3 бали -
Необхідно створити один з архітектурних документів на тему вашої лабораторної роботи №4 в залежності від варіанту.
Альтернативний варіант:
Сформувати документ на основі однієї з моделей АІ. Ваша задача створити цей документ або текст (програма) за допомогою створеної вами програми з будь-яким АІ API.- High-Level Design Document (HLD)
- Solution Architecture Document (SAD)
- System Architecture Overview
- Architectural Decision Records (ADRs)
- System Design Specification
- Architecture Design Description (ADD)
- Component Design Document (CDD)
- Design Requirements Document
- Architecture Design Review (ADR) Checklist
- Deployment Architecture Document
- Infrastructure Architecture Document
- Technology Architecture Document
- Security Architecture Document
- Integration Architecture Document
- Data Architecture Document
Оцінювання:
Сформований вірно документ 10 балів
Документ відповідає тематиці 5 балів
[бонус] АІ генеративна програма 15 балівШтраф за здачу після екзамену 8 балів
-
10 запитань, 25 балів
Для теоретичного треку - обовʼязковий, для проекту - як додаткові бали
-
-
-
Розробити або задокументувати ваш попередній (будь-який) проект. Персональний чи командний (команда до 4х осіб)
Або створити концепт майбутнього проекту та розробити декілька компонентів для документації (3-4).Проект має включати ліцензію, яка додана до проекту (ReadMe, package) та являється вірною для пакетів всередині застосунку.
Додати до проекту privacy & policy або EULA (Ліцензійна угода з кінцевим користувачем), яка покриває ваші юридичні моменти (можуть бути довільні) та обовʼязково регламентує роботу з GDPR.
Покрити системою автоматизованої документації код (декілька компонентів або модулів(3+)). Система може бути довільна - storybook, *doc, https://documentation.js.org/, https://docusaurus.io/, https://wiki.js.org/, https://github.com/slatedocs/slate
Swagger або Postman документування/виконання запитів (довільно 1+ кількість описаних запитів)
Оцінювання
Ліцензування проекту - 15 балів
Privacy & Policy/EULA - 25 балів
Автоматичне генерування документації - 20 балів
Swagger/Postman - 20 балів
Загалом 80 балів
Штрафи:
- Несвоєчасність. Здача після екзамену - -20 балів
- Невірна робота з гітом -5 балів*Ви повинні бути автором проекту або концепту.
-
Персональний чи командний (команда до 4х осіб)
Необхідно зробити документ з описом архітектури.
Якщо ваш проект це концепт, тоді необхідно зробити High-Level Design (HLD) document.
Якщо ваш проект це робоча програма, тоді необхідно зробити Solution Architecture Document (SAD).
За бажанням, можете зробити будь-який інший.
https://www.linkedin.com/pulse/software-architecture-documentation-quick-start-guide-denis-varchenko/
А також необхідно створити стислий документ на тендерну документацію, який включає наст моменти. Кожен з моментів може бути описаний буквально декількома абзацами.Визначення цільового ринку та аудиторії
Вивчення ключових конкурентних переваг
Проектування продукту та визначення основних характеристик
Вибір необхідних технологій та компонентів
Розробка прототипу для тестування та валідації
Енергоефективність та сталість
Якість та сертифікація
Підготовка до сертифікації на відповідність стандартам
Фінансове управління для стартапів.Оцінювання
Архітектурна документація - 20
Тендерна документація - 10
Загалом 30 балів
-
-
-
Opened: Tuesday, 19 March 2024, 8:25 AMClosed: Tuesday, 19 March 2024, 8:40 AM