Commit 60090b18 authored by Danir Tlepov's avatar Danir Tlepov

hello knowledge_req_spec

parent f05326cf
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/ReadtheDocsTemplate"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReadtheDocsTemplate"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
/* override table width restrictions */
@media screen and (min-width: 767px) {
.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}
.wy-table-responsive {
overflow: visible !important;
}
}
\ No newline at end of file
# -*- coding: utf-8 -*-
#
# Read the Docs Template documentation build configuration file, created by
# sphinx-quickstart on Tue Aug 26 14:19:49 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as Strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Спецификация требований Synergy Knowledge'
copyright = u'2019, ARTA Software'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1-alpha'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_context = {
'css_files': [
'_static/theme_overrides.css', # override wide tables in RTD theme
],
}
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'ReadtheDocsTemplatedoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation',
u'Read the Docs', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'readthedocstemplate', u'Спецификация требований Synergy Showcase',
[u'Read the Docs'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation',
u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
Условные обозначения
====================
В настоящем документе используются следующие определения, сокращения и аббревиатуры:
* **ОС** - операционная система;
* **ИС** - информационная система;
* **Система** - ИС «Knowledge»;
* **СУБД** - система управления базами данных;
* **Справочник** - перечень заранее определенных значений параметров объектов системы;
* **Форма** - тип файла в Системе, предназначенный для сбора и отображения структурированных данных;
* **Реестр** - способ представления данных по Форме в табличном виде;
* **Запись** - документ на основе Формы в Реестре.
Цели создания
=============
Целью создания Knowledge является предоставление обучающимся пользователям доступа к:
* просмотру профиля пользователя
* просмотру различного контента:
* обучающих курсов
* практических и итоговых заданий
* дополнительной литературы
.. Read the Docs Template documentation master file, created by
sphinx-quickstart on Tue Aug 26 14:19:49 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Содержание
==========
.. toctree::
:maxdepth: 2
:glob:
:numbered:
goals
glossary
requirements
Требования к разработке ИС «Knowledge»
=============================================
Общие требования к Системе
----------------------------------
.. csv-table::
:widths: 2, 30
3.1.1, "Система должна поддерживать работу на следующих серверных ОС: Linux, BSD, Solaris (рекомендуется использовать ОС Debian GNU/Linux 6.0 (amd64)."
3.1.2, "Система должна поддерживать работу на реляционных СУБД и на noSQL СУБД."
3.1.3, "Система не требует обязательного приобретения дополнительных компонентов (лицензии на ОС, на СУБД и т.п.)."
3.1.4, "Система должна поддерживать шифрование подключений с помощью протокола SSL (HTTPS)."
3.1.5, "Система должна поддерживать работу с распределённым хранилищем данных."
3.1.6, "Система должна обеспечивать возможность распределенной работы и удаленного доступа к ресурсам и объектам."
3.1.7, "Система должна поддерживать работу в архитектуре Internet/Intrаnet."
3.1.8, "Система должна предоставлять Web-интерфейс, который не требует установки клиентской части. Система должна поддерживать интернет-браузеры Google Chrome, Mozilla Firefox актуальных версий."
3.1.9, "Система должна предоставлять возможность реализовывать пользовательские интерфейсы, используя HTML и/или JavaScript."
3.1.10, "Система должна предоставлять комплект средств разработки (Software Development Kit - SDK), включая: REST API; способы авторизации: сессионная, по логину и паролю, по ключам; события, возникающие в различных точках исполняемого кода при выполнении определённых условий; очереди сообщений; поддержку плагинов; JavaScript интерпретаторы."
3.1.11, "Система должна предоставлять возможность регулирования доступа к объектам в соответствии с правами пользователя."
3.1.12, "Система должна предоставлять возможность создания, редактирования форм в визуальном редакторе форм."
3.1.13, "Система должна предоставлять инструмент управления бизнес-процессами, поддерживающий нотацию BPMN."
3.1.14, "Система должна предоставлять дизайнер бизнес-процессов. Создание и редактирование бизнес-процессов должно выполняться в рабочем пространстве дизайнера бизнес-процессов."
3.1.15, "Система должна поддерживать версионность документов."
Требования к модулям Системы
----------------------------
.. csv-table::
:widths: 2, 30
3.2.1, "Система должна предоставлять возможность в визуальном редакторе без программирования формировать каталог умений."
3.2.2, "Система должна предоставлять возможность в визуальном редакторе без программирования формировать каталог обучающих курсов с привязкой к умениям, описание и содержимое по урокам, а также группировать курсы."
3.2.3, "Система должна предоставлять возможность в визуальном редакторе без программирования формировать роли для обучения, а также привязывать к ним список обязательных к прохождению курсов и список дополнительной литературы."
3.2.4, "Система должна предоставлять возможность в визуальном редакторе без программирования формировать профили пользователей, назначать обязательные и дополнительные курсы, хранить историю их прохождения."
3.2.5, "Система должна предоставлять возможность в визуальном редакторе без программирования формировать каталог тестовых вопросов, группировать их с привязкой к обучающему курсу."
3.2.6, "Система должна предоставлять возможность в визуальном редакторе без программирования формировать индивидуальные планы развития пользователей."
3.2.7, "Система должна предоставлять модуль регистрации пользователей."
3.2.8, "Система должна предоставлять модуль авторизации пользователя."
3.2.9, "Система должна предоставлять модуль «Профиль» для просмотра информации о пользователе, в т.ч. о его статусе сертификации."
3.2.10, "Система должна предоставлять модуль «Мои курсы», содержащий список обязательных и дополнительных (при наличии) курсов пользователя, их статусы и сроки прохождения."
3.2.11, "Система должна предоставлять модуль «Все курсы», содержащий список всех курсов, как сгруппированным, так и общим списком."
3.2.12, "Система должна предоставлять модуль «Библиотека», содержащий список дополнительной литературы."
3.2.13, "Система должна предоставлять модуль «Обучающий курс» для просмотра и выполнения действий по выбранному курсу."
3.2.14, "Во время выполнения запросов к серверу Система должна отображать анимированное изображение."
Требования к навигации по Системе
--------------------------------------------
.. csv-table::
:widths: 2, 30
3.3.1, "Общая верхняя панель содержит кликабельные лейблы «SYNERGY ACADEMY LMS», а также «Фамилия Имя» с прогрессом обучения для авторизованного пользователя."
3.3.2, "Прогресс обучения формируется из количества завершенных обязательных курсов пользователя, где прогресс менее 100% соответствует пропорциональному количеству закрашенных звёзд, а полное завершение курсов соответствует знаку-ордену."
3.3.3, "Боковая панель отображается во всех модулях, кроме авторизации, регистрации, «Обучающий курс», и содержит пункты, соответствующие модулям: «Профиль», «Мои курсы», «Все курсы», «Библиотека»."
3.3.4, "Справа от пунктов меню, кроме «Профиль», отображается число, соответствующее количеству доступного контента в нем: «Мои курсы» - суммарное количество обязательных и дополнительных курсов пользователя, «Все курсы» - суммарное количество обучающих курсов в Системе, «Библиотека» - суммарное количество дополнительной литературы для роли пользователя."
3.3.5, "По нажатию на кликабельный лейбл «SYNERGY ACADEMY LMS» происходит переход в модуль «Все курсы»."
3.3.6, "По нажатию на кликабельный лейбл «Фамилия Имя» с прогрессом обучения происходит переход в модуль «Профиль»."
3.3.7, "Подвал содержит статическую информацию: копирайт компании-разработчика, телефон, электронная почта и логотип-ссылка на сайт компании."
3.3.8, "Выход из системы в модуль авторизации доступен в модуле «Профиль»."
3.3.9, "Верхняя панель и подвал отсутствуют в модулях авторизации и регистрации."
Требования к модулю авторизации
--------------------------------------------
.. csv-table::
:widths: 2, 30
3.4.1, "Модуль авторизации доступен только для неавторизованных пользователей."
3.4.2, "На странице авторизации доступна следующая форма ввода: логин (поле ввода, обяз.), пароль (поле ввода со скрытием вводимых символов, обяз.)."
3.4.3, "По нажатию на кнопку «Войти в систему» Система должна авторизовать пользователя."
3.4.4, "Авторизация должна произойти успешно только при одновременном выполнении следующих условий: в Системе существует введенная учетная запись пользователя, имеются все модули из таблицы 3.2, имеется профиль авторизующегося пользователя."
3.4.5, "Во всех остальных случаях авторизация считается неуспешной, пользователю выводится аргументированное сообщение, он остается на экране авторизации."
3.4.6, "В результате успешной авторизации пользователь переходит в модуль «Все курсы»."
3.4.7, "После формы ввода авторизации должна отображаться кнопка перехода к модулю регистрации."
Требования к модулю регистрации
------------------------------------
.. csv-table::
:widths: 2, 30
3.5.1, "Модуль регистрации доступен только для неавторизованных пользователей."
3.5.2, "На странице регистрации доступна следующая форма ввода: электронная почта (поле ввода с маской для e-mail, обяз.), фамилия (поле ввода, обяз.), имя (поле ввода, обяз.), роль в системе (выпадающий список, обяз.), пароль (поле ввода со скрытием вводимых символов, обяз.)."
3.5.3, "Процесс регистрации по введенным атрибутам должен включать в себя: создание учетной записи, создание профиля пользователя."
3.5.4, "По нажатию на кнопку «Зарегистрироваться» Система должна проверить наличие учетной записи по введенному e-mail."
3.5.5, "Регистрация должна произойти успешно только при условии, что в Системе отсутствует учетная запись с введенным e-mail."
3.5.6, "В случае, если в Системе существует учетная запись с введенным e-mail, регистрация считается неуспешной, пользователю выводится аргументированное сообщение, он остается на экране регистрации."
3.5.7, "В результате успешной регистрации пользователь переходит в модуль авторизации, автоматической авторизация отсутствует."
3.5.8, "После формы ввода регистрации должна отображаться кнопка перехода к предыдущему модулю авторизации."
Требования к модулю «Профиль»
-----------------------------------
.. csv-table::
:widths: 2, 30
3.6.1, "Модуль «Профиль» доступен только для авторизованных пользователей."
3.6.2, "Модуль «Профиль» может содержать следующую информацию о пользователе: полные фамилию, имя и отчество самого пользователя и его менеджера обучения, роль (должность), подразделение, офис, а также статус сертификации."
3.6.3, "Статус сертификации пользователя показывает количество пройденных обязательных курсов и общее количество обязательных курсов."
3.6.4, "Модуль «Профиль» содержит кнопку «Выйти», по нажатию которой открывается модуль авторизации."
3.6.5, "Модуль «Профиль» содержит кнопку возврата в предыдущий модуль."
Требования к модулю «Мои курсы»
----------------------------------
.. csv-table::
:widths: 2, 30
3.7.1, "Модуль «Мои курсы» доступен только для авторизованных пользователей."
3.7.2, "Модуль «Мои курсы» может содержать 2 блока обучающих курсов: обязательные и дополнительные."
3.7.3, "Каждый элемент блока соответствует одному обучающему курсу и может содержать: название, автор, обложка, текущий статус прохождения, срок завершения курса."
3.7.4, "Для обучающих курсов в статусе «Обучение» и имеющимся сроком завершения доступно визуальное отображение оставшегося времени, а также признак просроченности."
3.7.5, "При наведении на обучающий курс происходит его визуальное выделение."
3.7.6, "По нажатию на обучающий курс открывается модуль «Обучающий курс»."
3.7.7, "Модуль «Мои курсы» содержит кнопку возврата в предыдущий модуль."
Требования к модулю «Все курсы»
--------------------------------------
.. csv-table::
:widths: 2, 30
3.8.1, "Модуль «Все курсы» доступен только для авторизованных пользователей."
3.8.2, "Модуль «Все курсы» может отображаться в двух вариантах: группами курсов (по умолчанию) и общим списков всех курсов."
3.8.3, "Переключение между данными вариантами осуществляется с помощью тумблера «Курсы подряд» (по умолчанию, он выключен)."
3.8.4, "Каждый элемент блока в групповом списке соответствует одной группе курсов и может содержать: название, описание и обложка группы, а также количество курсов в группе."
3.8.5, "Плашки групп отсортированы по убыванию количества курсов в них."
3.8.6, "При наведении на группу происходит ее визуальное выделение."
3.8.7, "По нажатию на группу открывается экран со сплошным списком обучающих курсов, принадлежащих выбранной группе. Тумблер «Курсы подряд» не отображается, а экран содержит кнопку возврата в предыдущий модуль."
3.8.8, "Адаптация под экраны: PC/Laptop - 2 плашки групп на одной строке, Tablet/Mobile - 1 плашка группы на одну строку."
3.8.9, "Каждый элемент блока в общем списке соответствует одному обучающему курсу и может содержать: название, автор и обложка курса."
3.8.10, "При наведении на обучающий курс происходит его визуальное выделение."
3.8.11, "По нажатию на обучающий открывается модуль «Обучающий курс»."
3.8.12, "Адаптация под экраны: PC/Laptop - 3 плашки курсов на одной строке, Tablet/Mobile - 2 плашки курсов на одну строку."
Требования к модулю «Библиотека»
---------------------------------------
.. csv-table::
:widths: 2, 30
3.9.1, "Модуль «Библиотека» доступен только для авторизованных пользователей."
3.9.2, "Модуль «Библиотека» может содержать файл и/или ссылку на файл."
3.9.3, "По нажатию на файл он открывается в новой вкладке текущего браузера (WebView, без предварительного скачивания)."
3.9.4, "По нажатию на ссылку открывается новая вкладка в текущем браузере."
Требования к модулю «Обучающий курс»
----------------------------------------
.. csv-table::
:widths: 2, 30
3.10.1, "Модуль «Обучающий курс» доступен только для авторизованных пользователей."
3.10.2, "При первом открытии модуля основная рабочая область должна отображать описание выбранного курса."
3.10.3, "Страница описания курса может содержать: название, автор и обложка курса, описание и признак умения, способ проверки и результат, примечание, а также кнопки «Добавить в Мои курсы», «Начать курс»."
3.10.4, "Кнопка «Добавить в Мои курсы» отображается, только если обучающий курс отсутствует в «Моих курсах» пользователя, в любом из блоков."
3.10.5, "По нажатию на кнопку «Добавить в Мои курсы» обучающий курс добавляется в список дополнительных."
3.10.6, "Кнопка «Начать курс» отображается, только если обучающий курс есть в «Моих курсах» пользователя и его текущий статус - «Без статуса»."
3.10.7, "По нажатию на кнопку «Начать курс» открывается компонент выбора даты. В результате выбора даты обучающий курс меняет статус на «Обучение», принимает установленный пользователем срок завершения."
3.10.8, "Боковая панель модуля «Обучающий курс» должна отображать содержание курса."
3.10.9, "Содержание курса формируется из названий всех уроков и итогового задания."
3.10.10, "По нажатию в содержании курса на урок основная рабочая область должна отображать описание выбранного урока."
3.10.11, "Страница описания урока может содержать: название и содержание урока, встроенное видео Youtube, набор файлов и/или ссылок, текстовые данные."
3.10.12, "По нажатию в содержании курса на итоговое задание основная рабочая область должна отображать описание итогового задания."
3.10.13, "Страница описания итогового задания может содержать: описание и инструкция к выполнению, набор файлов и/или ссылок, текстовые данные, а также кнопку «Завершить курс» либо компонент тестирования."
3.10.14, "Кнопка «Завершить курс» отображается, только если обучающий курс есть в «Моих курсах» пользователя, его текущий статус - «Обучение», к курсу не привязано тестирование и курс не имеет атрибута «находится на проверке у менеджера обучения»."
3.10.15, "По нажатию на кнопку «Завершить курс» открывается окно подтверждения завершения. При отрицательном ответе пользователь остается на странице описания итогового задания. При положительном ответе запускается следующий этап маршрута - согласование выполнения задания менеджером обучения."
3.10.16, "Если менеджер обучения согласовывает результат выполнения, то курс автоматически принимает статус «Обучение завершено»."
3.10.17, "Если менеджер обучения отказывает в согласовании результат выполнения, то курс остается в статусе «Обучение», снимается атрибут «находится на проверке у менеджера обучения»."
3.10.18, "Компонент тестирования отображается, только если обучающий курс есть в «Моих курсах» пользователя, его текущий статус - «Обучение» и к курсу привязано тестирование."
3.10.19, "Компонент тестирования автоматически определяет успешность прохождения курса."
3.10.20, "Если пороговый уровень пройден, то курс автоматически принимает статус «Обучение завершено», иначе - курс остается в статусе «Обучение»."
3.10.21, "По нажатию на файл он открывается в новой вкладке текущего браузера (WebView, без предварительного скачивания)."
3.10.22, "По нажатию на ссылку открывается новая вкладка в текущем браузере."
3.10.23, "Страницы описания уроков и итогового задания содержат кнопку возврата на страницу описания курса."
3.10.23, "Страница описания курса содержит кнопку возврата в предыдущий модуль."
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment