Copyright © 1999 by Karl E. Wiegers. Permission is granted to use, modify, and distribute this document. Спецификация на софтуерните изисквания for Interoom Version 1.0 Authors: Yoan Babulkov Ivan Dosev Iva Boshnakova Nikola Mihaylov Software Requirements Specification for Interoom Page 2 Съдържание 1. Въведение 1 1.1 Основна цел 1 1.2 Конвенции на документа 1 1.3 Търсена публика и съвети за четене 1 1.4 Обхват на продукта 1 1.5 Референции 1 2. Цялостно описание 2 2.1 Перспектива на проекта 2 2.2 Функции на продукта 2 2.3 Потребителски класове и характеристики 2 2.4 Операционни среди 3 2.5 Ограничения за дизайн и разработка 3 2.6 Потребителска документация 3 2.7 Предположения и зависимости 3 3. Външни интерфейсни изисквания 3 3.1 Потребителски интерфейси 3 3.2 Хардуерни интерфейси 8 3.3 Софтуерни интерфейси 8 3.4 Комуникационни интерфейси 8 4. Системни изисквания 8 4.1 Влизане в системата 8 4.2 Редактиране на профила 9 4.2.1 Описание и приоритет 9 4.2.2 Функционални изисквания 9 4.3 Възможности на регистрирания потребител спрямо други потребители 10 4.3.1 Описание и приоритет 10 4.3.2 Функционални изисквания 10 4.4 Допълнителни функционални изисквания 11 5. Други нефункционални изисквания 12 5.1 Изисквания за производителност 12 5.2 Изисквания за поддръжка 13 5.3 Изисквания за безопасността 13 Software Requirements Specification for Interoom Page 3 5.4 Изисквания за сигурността 13 5.5 Софтуерни атрибути на качества 13 5.6 Бизнес изисквания 14 5.6.1 Награден фонд 14 5.6.2 Контрол на съдържанието 14 5.6.3 Защита на личните данни 14 6. Other Requirements 14 Revision History Name Date Reason For Changes Version Software Requirements Specification for Interoom Page 1 1. Въведение 1.1 Основна цел Целта на документа е да представи в детайли версия 1.0 на продукта "Interoom". Той ще обясни целта и харектиристиките на софтуера, неговите функционални и нефункционални изисквания, и интерфейс. 1.2 Конвенции на документа Взети са предвид всички правила и препоръки, за да подсигури максималната четимост и разбираемост на документа от аудиторията. 1.3 Търсена публика и съвети за четене Този документ е подходящ за project мениджърите, разработчиците, хората от отдела по контрол на качеството и хората от отдела по продажби. 1.4 Обхват на продукта Interoom е онлайн мобилна среда за обучение и надграждане на знанията, която е създадена в помощ на образователната система. Основната цел на продукта е да се използва от колкото се може повече училища, мотивирайки учениците от първи до седми клас да усвоя ват учебния материал. Това се постига на базата интерактивен модел на обучение, включващ в себе си викторини, образователни и състезателни игри. 1.5 Референции Подобни системи: https://ucha.se – платформа за онлайн уроци. https://kahoot.it/ - платформа за викторини. https://www.funbrain.com/ - платформа за образователни игри. Продуктът се различава от изброените системи с множество допълнителни функционалности описани в 2.2 Software Requirements Specification for Interoom Page 2 2. Цялостно опис ание 2.1 Перспектива на проекта Образованието е основополагащ фактор, развиващ държава в много аспекти (икономически, интелектуален и т.н). В България все повече млади хора, губят интерес към учението, поради архаичната структура на образователната система. Тази тенденция застрашава бъдещото развитие на държавата, за това е нужно да се вземат навремени мерки, а именно подпомагане процеса на обучение. Interoom е иновативен софтуер , чиято цел е да надгради текущото ниво на българското образование. Няма други подобни приложения, които са интегрирани в училищата. 2.2 Функции на продукта Основни функционалности: ● Създаване и участие във викторини ● Интерактивни образователни игри ● Интуитивен и лесен за използване интерфейс ● Роли на потребителите с различни права за достъп ● Ранкова система и постижения ● Система против преписване ● Аватар с опции за персонализиране ● Административни права на учителите ● Споделена бяла дъска за обмен на идеи и съдействие. ● Онлайн разговор и чат ● Ежемесечни спонсорирани конкурси с награди. ● Опция за алгоритмично подбрано дигитално учебно съдържание, съобразено с интересите и класа на ученика. ● Споделяне на успехи между отделните участници във викторини и турнири 2.3 Потребителски класове и характеристики Платформата може да бъде използване както от малки, така и от големи ученици, като се очаква по - голяма част от потребителите да са от 1 до 7 клас. Системата се изгражда от следните потребителски роли: ● Админ (училищен администратор) – притежава достъп до пълната функционалност на приложението и неговата длъжност е да поддържа интегритета съдържанието на платформата, създава турнири. ● Учител – отговаря за създаване на викторини и модериране на вече съществуващи. Притежава възможността да награждава учениците. ● Ученик – участва във викторини и състезания. Software Requirements Specification for Interoom Page 3 ● Родител – следи активността на детето в приложението. ● Гост (нерегистриран потребител) – наблюдава турнирите, няма достъп до основните функционалности. 2.4 Операцион ни среди Всяко мобилно устройство поддържащо поне Android 8.0 Oreo или по - нови модели от iPhone 7, или всяко мобилно устройство имащо инсталиран NFC таг. 2.5 Ограничения за дизайн и разработка Платформата ще бъде развита следвайки итеративния модел на процес. Първоначално ще се използва чужд софтуер за голяма част от функционалностите, като с времето ще се да замести с наш собствен. Затова се очакват: • ограничения, поставяни от производителите на отделните сегменти, във връзка със свободата на използване на техния софтуер • невъзможност за отстраняване на потенциални проблеми с чуждите системи • силна зависимост от трети страни, особено в началото 2.6 Потребителска документация Interoom се стреми да бъде възможно най - удобна за използване от нейните пот ребители, затова платформата предоставя: • Online guides, водени от анимирани герои, които да запознават потребителите с функционалността на платформата • Q&A секция • 24/7 online support 2.7 Предположения и зависимости Като начало платформата ще бъде силно зависима от инвеститорите. Поради тази причина е възможно да възникнат следните проблеми: • оттегляне на подкрепата по всяко време • поставяне на дадени ограничения • влияние върху качеството на продукта. 3. Външни интерфейсни изисквания 3.1 Потребителски интерфейси <Describe the logical characteristics of each interface between the software product and the users. This may include sample screen images, any GUI standards or product family style guides that are to be followed, screen layout constraints, standard buttons and functions (e.g., help) that will appear on every screen, keyboard shortcuts, error message display standards, and so on. Define the Software Requirements Specification for Interoom Page 4 software components for which a user interface is needed. Details of the user interface design should be documented in a separate user interface specification.> Software Requirements Specification for Interoom Page 5 Software Requirements Specification for Interoom Page 6 Software Requirements Specification for Interoom Page 7 Software Requirements Specification for Interoom Page 8 3.2 Хардуерни интерфейси <Describe the logical and physical characteristics of each interface between the software product and the hardware components of the system. This may include the supported device types, the nature of the data and control interactions between the software and the hardware, and communication protocols to be used.> 3.3 Софтуерни интерфейси <Describe the connections between this product and other specific s oftware components (name and version), including databases, operating systems, tools, libraries, and integrated commercial components. Identify the data items or messages coming into the system and going out and describe the purpose of each. Describe the s ervices needed and the nature of communications. Refer to documents that describe detailed application programming interface protocols. Identify data that will be shared across software components. If the data sharing mechanism must be implemented in a spe cific way (for example, use of a global data area in a multitasking operating system), specify this as an implementation constraint.> 3.4 Комуникационни интерфейси <Describe the requirements associated with any communications functions required by this product , including e - mail, web browser, network server communications protocols, electronic forms, and so on. Define any pertinent message formatting. Identify any communication standards that will be used, such as FTP or HTTP. Specify any communication security or encryption issues, data transfer rates, and synchronization mechanisms.> 4. Системни изисквания 4.1 Влизане в системата 4.1.1 Описание и приоритет Влизане в системата чрез потребителско име и парола от електронния дневник на училището при роли: ● Ученик ● Учител ● Родител ● Администратор Влизане в системата без нужда от потребителско име и парола при роля Гост Приоритет: висок Software Requirements Specification for Interoom Page 9 4.1.2 Функционални изисквания 4.1.2.1 Потребителят въвежда потребителско име и парола /изключение при гост, където не се изискват допълнителни данни/ 4.1.2.2 Данните за потребителите трябва да съвпадат с тези от електронния дневник 4.1.2.3 При некоректно попълнено поле се появява съобщение за грешка, описваща проблема. 4.1.2.4 Ако потребител без достъп до системат а се опита да влезе с име и парола, която не е в базата данни, се извежда грешка: „Такъв потребител не съществува!“. 4.1.2.5 Различните роли притежават съответен достъп до функционалностите на системата 4.2 Редактиране на профила 4.2.1 Описание и приоритет Осно вна информация на потребителя: Име и фамилия ● E - mail ● Аватар ● Социални мрежи ● Място в ранковата система ● Постижения ● Спечелени награди ● Теми на интерес Приоритет : висок 4.2.2 Функционални изисквания 4.2.2.1 Потребителят има възможността да редактира профила си само след влизане в системата. 4.2.2.2 Име, фамилия и e - mail се попълват автоматично от използвайки данните от електронния дневник. 4.2.2.3 Има възможност за добавяне на акаунти в социалните мрежи : • Facebook • YouTube • Instagram Commented [1]: Да се сложат уникални номера на всяко изискване - важи и за всички изисквания по - долу Software Requirements Specification for Interoom Page 10 • TikTok 4.2.2.4 Персонализиране на аватара 4.2.2.5 Селектиране теми на интерес 4.3 Възможности на регистрирания потребител спрямо други потребители 4.3.1 Описание и приоритет Предоставяне на възможност за интеракция между потребителите Приоритет: висок 4.3.2 Функционални изисквания 4.3.2.1 Системата предлага различни роли на потребителите с различни права за достъп. 4.3.2.2 Системата дава възможност за търсене на други потребители по потребителско име. 4.3.2.3 Системата дава възможност за п реглед на публичната информация в профила на друг потребител. 4.3.2.4 Interoom дава възможност за и зпраща не на текстови съобщения до други потребители в рамките на платформата 4.3.2.5 Системата предлага провежда не на аудио разговори 4.3.2.6 Interoom позволява добавя нето на други потребители в свой списък с приятели. 4.3.2.7 Системата дава възможност за премахване на други потребители от своя списък с приятели. 4.3.2.8 Регистрираният потребител има възможността да създава приятелски игри. Commented [2]: Добре би било да се разшири обхвата на системата и съответно да има повече изисквания - може да помислите за класации, споделяне на успехи и др. Software Requirements Specification for Interoom Page 11 4.3.2.9 Регистрираният потребил има възможността да участва в приятелски игри. 4.3.2.10 Системата предлага преглед на постиженията на други потребители. 4.3.2.11 Interoom дава възможност за персонализиране на свой личен аватар. 4.3.2.12 Системата разполага със споделена бяла дъска за обмен на идеи между учениците. 4.3.2.13 Interoom провежда ежемесечни спонсорирани конкурски с награди от всякакъв вид. Регистрираният потребител се разширява от следните роли - учител, ученик, родител Учителят може да: 4.3.2.14 Създава викторини на различни теми. 4.3.2.15 Поощрява учениците чрез дигитални награди (значки) за добро представяне на викторина. Ученикът може да: 4.3.2.16 У частва в турнири 4.3.2.17 Създава приятелски игри със свои съученици. 4.4 Допълнителни функционални изисквания 4.4.1 Системата позволява докладване то на неуместно съдържание ( отговор на въпрос от викторина, коментар или рисунка на бялата дъска ) 4.4.2 При наличие на докладвано съдържание, системата изпраща на администраторите известие за него. 4.4.3 След преразглеждане на докладваното съдържание, администраторите могат да: 4.4.3.1 Изтрият съответното съдържание. 4.4.3.2 Санкционират автора му. Commented [3]: 2 в 1 и да се поясни как става Software Requirements Specification for Interoom Page 12 5. Други нефункционални изисквания 5.1 Изисквания за производителност Приложението трябва да е способно да поддържа поток от голям брой потребители без това да се отразява на скоростта. Времето за регистриране докосването на бутон и осъществяване на избраната операция не трябва да отнема повече от 0,5 секунди. Изключение в с пазването на скоростта се допуска само при наличие на проблем при интернет връзката на потребителя, при което се отдава времеви диапазон от 15 секунди за преустановяване на връзка между приложението и клиента. При надхвърляне на времевата граница, потребит елят бива уведомен, че системата не може да го обслужи, за да се гарантира бързото обслужване на клиентите с изправна интернет връзка. Commented [4]: Тези изисквания също трябва да имат уникални номера Commented [5R4]: В какъв смисъл уникален номер? Commented [6]: Това не звучи никак добре - по - скоро да бъде уведомен, ч системата не може да го обслужи поради лоша връзка Software Requirements Specification for Interoom Page 13 5.2 Изисквания за поддръжка Предвидена е системна профилактика в срок до 4 астрономически часа всеки месец, като тя ще бъде провеждана в периоди на ниска използваемост на платформата 5. 3 Изисквания за безопасността Приложението ще съдържа алгоритъм, който проверява за нецензурирано съдържание. При грешно определяне на информацията като нецензурирана, то може да се изисква преразглеждане на решението от администраторите. Продължителното споделяне на нецензурирано съдържание ще доведе до перманентно ограничаване на достъп до платформата от съответния профил. 5.4 Изисквания за сигурността Системата предупреж дава при отварянето на линк, който не е пряко свързан със софтуера. Всеки път, когато се започне чат, в началото на чата се показва съобщение, което предупреждава да не се споделят лични данни, като е - майл, парола и локация. Продуктът ще има и опцията “дво йна автентикация”, която може да се свърже към мобилния телефон, която помага да се защити профила на всеки отделен потребител, като всеки път когато той влезе ще му иска код, който ще му бъде пратен като смс. Когато някой потребител има двойна автентикаци я, но си е загубил телефона, ще има и таен въпрос с таен отговор, който трябва да ги е записал и/или запомнил, в случай, че вече няма никакъв достъп до профила си. 5.5 Софтуерни атрибути на качества Приложението притежава интуитивен и user - friendly интерфейс, към който потребителите ще могат да се приспособят за не повече от 15 минути, подходящ за мобилни устройства и таблети . Платформата ще е на разп оложение 24 часа в денонощието. Д остъпна до всички масово използвани операционни системи за мобилни устройства (Android, iOS, Bada, Windows OS, HarmonyOS). Осигурява се гаранция за качество на учебното съдържание, чрез периодично преглеждане и редактиране от авторите на материала и добр оволци (като редакцията от доброволци ще бъде преглеждана за неизправности). При възникнал проблем със сървъра, той ще бъде отстранен до 24 часа. Commented [7]: Различно изискване Commented [8]: Всички термини ида се сложат в речник Software Requirements Specification for Interoom Page 14 5.6 Бизнес изисквания 5.6.1 Награден фонд ● Наградният фонд се осигурява от представителите на Interoom и те хните спонсори. 5.6.2 Контрол на съдържанието ● Да се предпазват потребителите от неподходящи за тях материали, без изричното съгласие от страна на родител/настойник. 5.6.3 Защита на личните данни ● Да се спазят всички принципи от Общия регламент относно защитата на данните (GDPR). 6. Other Requirements <Define any other requirements not covered elsewhere in the SRS. This might include database requirements, internationalization requirements, legal requirements, reuse objectives for the project, an d so on. Add any new sections that are pertinent to the project.> Appendix A: Glossary <Define all the terms necessary to properly interpret the SRS, including acronyms and abbreviations. You may wish to build a separate glossary that spans multiple projects or the entire organization, and just include terms specific to a single project in each SRS.> Appendix B: Analysis Models Software Requirements Specification for Interoom Page 15 Activity diagrams: 1. Влизане в профил Software Requirements Specification for Interoom Page 16 2. Редактиране на профила Software Requirements Specification for Interoom Page 17 3. Участие във викторина и гледане на класация