3 Требования к информационной архитектуре

advertisement
Техническое задание на разработку сайта
для компании ООО "Жилкомсоюз"
Версия 1.1
Оглавление
1 Введение ........................................................................................................................................ 3
1.1 Неформальная постановка задачи ................................................................................. 3
1.2 Цель создания и задачи .................................................................................................... 3
2 Требования к интерфейсу ............................................................................................................ 3
3 Требования к информационной архитектуре ............................................................................. 3
3.1 Карта сайта (иерархия страниц)...................................................................................... 3
3.2 Описание страниц ............................................................................................................ 4
3.2.1 Главная страница ..................................................................................................4
3.2.2 О компании ............................................................................................................4
3.2.2.1 Сотрудники ............................................................................................... 4
3.2.3 Новости .................................................................................................................5
3.2.3.1 Страница одной новости ......................................................................... 5
3.2.4 Финансовая отчетность ........................................................................................5
3.2.4.1 Бухгалтерская отчетность ....................................................................... 5
3.2.4.2 Сведения о доходах .................................................................................. 5
3.2.4.3 Сведения о расходах ............................................................................... 5
3.2.5 Услуги и цены .......................................................................................................6
3.2.5.1 Перечень услуг и стоимость .................................................................. 6
3.2.5.2 Планы и сведения о выполнении работ ................................................. 6
3.2.6 Коммунальные ресурсы .......................................................................................7
3.2.7 Перечень МКД ......................................................................................................7
3.2.8 Документы ............................................................................................................7
3.2.8.1 Договора.................................................................................................... 7
3.2.8.2 Правовая информация ........................................................................... 8
3.3 Спецификация информации (спецификация данных) ................................................. 8
3.3.1 Статья .....................................................................................................................8
3.3.2 Сотрудник .............................................................................................................8
3.3.3 Новость .................................................................................................................8
3.3.4 Финансовый отчет ...............................................................................................9
3.3.5 Услуга ....................................................................................................................9
3.3.6 План работы .........................................................................................................9
3.3.7 МКД ......................................................................................................................9
4 Структура шаблона .................................................................................................................... 10
4.1 Регионы .......................................................................................................................... 10
4.1.1 Шапка ..................................................................................................................10
4.1.2 Левая панель .......................................................................................................10
4.1.3 Правая панель ..................................................................................................... 11
4.1.4 Основной контент ............................................................................................... 11
4.1.5 Подвал .................................................................................................................. 11
4.2 Блоки ............................................................................................................................... 11
4.2.1 Последние новости ............................................................................................. 11
4.2.2 Финансовая отчетность ...................................................................................... 11
4.2.3 Документы ........................................................................................................... 11
4.2.4 Основный ссылки .............................................................................................. 11
5 Система навигации по сайту ...................................................................................................... 12
5.1 Главное меню .................................................................................................................. 12
6 Требования к наполнению контентом ....................................................................................... 12
7 Результат ...................................................................................................................................... 12
8 Соглашения ................................................................................................................................. 13
9 Этапы и сроки ............................................................................................................................. 13
1 Введение
1.1 Неформальная постановка задачи
Необходимо в разработать сайт для публикации информации подлежащей публичному
разглашению, согласно принятого правительством РФ закона. Кроме интерфейса для
пользователей Интернет, сайт доложен содержать интерфейс администрирования, для
редактирования и постоянного пополнения информации, так как информация подлежит
периодическому изменению. Система, на которой будет разработан сайт, должна быть
расширяема, так как в дальнейшем возможно увеличение станиц и функционала сайта
1.2 Цель создания и задачи
На текущий момент, основная цель создания сайта — это публикация (разглашение) только
информации указанной в принятом законе . Т.о. главная задача — это реализовать площадку
в Интенет (сайт) для публикации этой информации и дополнительные средства, для
изменения и дополнения этой информации. На текущий момент нет необходимости
реализовывать на сайте дополнительные сервисы (услуги) для пользователей и абонентов
компании, но необходимо предусмотреть возможное их использование в будущем.
2 Требования к интерфейсу
Сайт должен иметь 2 интерфейса:

пользовательский - для пользователя сети Интернет, разрабатывается на основе
утвержденного дизайна. В настоящее время нет разработанного и утвержденного
дизайна , поэтому будет использоваться стандартная тема установленной системы.

административный. Должен позволять алминистратору сайта:
◦ управлять иерархией страниц
◦ создавать, удалять, изменять разделы
◦ создавать, удалять, изменять информационные единицы (статьи, услуги, отчеты
ит.п. см. раздел «Спецификация данных»)
◦ управлять отображением разделов и информационных единц
◦ управлять блоками в шаблоне
3 Требования к информационной архитектуре
3.1 Карта сайта (иерархия страниц)
Согласно анализа принятого закона необходимо реализовать следующую структуру страниц:
1 Главная страница
2 О компании
1.1
История и структура компании
1.2 Контакты
1.3 Сотрудники
1.4 Реквизиты
3 Новости
3.1 Страница одной новости
4 Финансовая отчетность
4.1 Бухгал терская отчетность - раздел
4.2 Сведения о доходах - раздел
4.3 Сведения о расходах - раздел
5 Услуги и цены
5.1 Перечень услуг и стоимость — раздел
5.1.1
Страница услуги
5.2 Планы и сведения о выполнении работ - раздел
6 Коммунальные ресурсы
7 Перечень МКД
8 Документы
8.1 Типовые договора
8.2 Правовая информация
Разделы отображают содержащуюся в них информацию в виде списков, внешний вид
(структура) каждого списка может отличаться.
3.2 Описание страниц
3.2.1 Главная страница
Отображает 2 блока:
 Приветствие — краткая информация о сайте
 Список анонсов новостей из 5 последних добавленных новостей
3.2.2 О компании
Для данной страницы нет отдельной статьи. При переходе на эту страницу отображается
страница «1.1 История и структура компании» согласно карте сайта. Все дочерние страницы,
кроме «1.3 Сотрудники», отображают статьи с соответствующими названиями. Тело каждой
статьи содержит html страницу.
3.2.2.1 Сотрудники
Отображает информацию о сотрудниках только в виде списка на странице. Список имеет
следующую структуру:
1 Название подразделения 1
1.1
1.2
1.3
Информация о сотруднике 1
1.1.1
Фотография сотрудника
1.1.2
ФИО
1.1.3
Должность
1.1.4
Описание
Информация о сотруднике 2
1.2.1
Фотография сотрудника
1.2.2
ФИО
1.2.3
Должность
1.2.4
Описание
… и т. д.
2 Название подразделения 2 … и т.д.
3.2.3 Новости
Страница отображает список анонсов новостей (описание анонса см. выше) . Требования к
списку:

Список должен отсортирован по дате создания новости, наиболее актуальные новости
должны располагаться сверху.

Количество одновременно отображаемых элементов — 10

Список должен со держать разбиение на страницы, если новостей в разделе больше 10
Анонс новости состоит из:

дата, автор, заголовок,

краткий текст новости,

ссылка - «подробнее» для перехода на страницу с полным текстом новости
3.2.3.1 Страница одной новости
Отображает полный текст новости. Полный текст состоит из:

дата, автор, заголовок,

полный текст новости,

фотография
3.2.4 Финансовая отчетность
Страница отображает 3 блока, соответствующих подразделам (см. Карта сайта)
Каждый блок отображается следующим образом:
1. Заголовок – является ссылкой на страницу подраздела
2. Таблица отчетов из 3-х последних добавленных отчетов в соответствующий раздел .
Требования к таблице:
 Таблица содержит 3 столбца: период, файл для скачивания, комментарии
 Заголовки столбцов отображаться в шапке таблицы.
3. Ссылка «Показать всё» - для перехода в соответствующий подраздел.
3.2.4.1 Бухгалтерская отчетность
Отображает входящие в него отчеты в виде таблицы. Требования к таблице:
 Столбцы и их заголовки аналогичны указанным выше.

Заголовки столбцов отображаться в шапке таблицы.

Количество одновременно отображаемых элементов — 10

Таблица должна содержать разбиение на страницы, если элементов больше 10
3.2.4.2 Сведения о доходах
Аналогично «Бухгалтерская отчетность»
3.2.4.3 Сведения о расходах
Аналогично «Бухгалтерская отчетность»
3.2.5 Услуги и цены
Страница отображает 3 блока, соответствующих подразделам, кажды блок отображается в
виде:
1. Заголовок блока — является ссылкой для перехода на страницу подраздела
2. Описание подраздела
3.2.5.1 Перечень услуг и стоимость
Отображает список услуг в таблицы:. Требования к таблице:
 Таблица содержит 2 столбца: название и стоимость. Название услуги в каждой строке
является ссылкой на страницу услуги. Стоимость отображается в виде текста.

Заголовки столбцов отображаться в шапке таблицы.

Таблица отображает весь список доступных услуг

Услуги могут быть сгруппированы в таблице по типу, в этом случае тип услуги
выводиться отдельной строкой во всю ширину таблицы,а под ним услуи данного типа
и т. д.
3.2.5.1.1 Страница услуги
Отображает полную информацию о услуге, а именно:
1. Название
2. Тип услуги
3. Описание услуги — текстовое описание услуги
4. Периодичность выполнения (ежедневно, еженедельно, ежемесячно, ежеквартально,
ежегодно)
5. результат выполнения — текстовое описание результата
6. гарантийный срок — текстовое описание
7. факторы определяющие выбор данной услуги для МКД — текстовое описание
8. стоимость
3.2.5.2 Планы и сведения о выполнении работ
Отображает все планы работ в виде таблицы .Требования к таблице:

Таблица содержит столбцы:
◦ Дата начала работ — возможна сортировка по этому столбцу
◦ Дата окончания работ — возможна сортировка по этому столбцу
◦ Файл плана — каждая строка таблицы в этом столбце содержит ссылку
для скачивания файла плана работ .
◦ Связанный МКД (или список МКД)
◦ Статус
◦ Отчет о выполнении плана - каждая строка таблицы в этом столбце
содержит ссылку для скачивания файла отчет о выполнении плана.
◦ Комментарии

Заголовки столбцов отображаться в шапке таблицы.

Количество одновременно отображаемых строк — 10

Таблица должна содержать разбиение на страницы, если элементов больше 10

Таблица должна содержать фильтр по:
◦ дата начала работ
◦ дата окончания работ
◦ статус выполнения
3.2.6 Коммунальные ресурсы
Отображает статью, в которая содержит ссылки для скачивания:
1. Перечень ресурсов и тарифы РСО
2. Перечень ресурсов и тарифы потребителей
3.2.7 Перечень МКД
Отображает с список МКД в виде таблицы. Требования к таблице:

Таблица содержит столбцы:
◦ Адрес
◦ Общая площадь
◦ Дата заключения договора
◦ Статус договора
◦ Ссылка на скачивание договора

Заголовки столбцов отображаться в шапке таблицы.

Количество одновременно отображаемых строк — 10

Таблица должна содержать разбиение на страницы, если элементов больше 10

Таблица должна содержать фильтр в виде меню:
◦ действующие договора — активен по умолчанию при загрузке таблицы
◦ расторгнутые договора
3.2.8 Документы
Отображает 2 блока дочерних подразделов в виде:
1. Заголовок подраздела
2. Список из 5 последних добавленных в подраздел элементов.
3.2.8.1 Договора
Отображает список наименований документов, являющихся ссылками для скачивания
данного договора
3.2.8.2 Правовая информация
Отображает список наименований статей законов. Наименование является либо ссылкой для
скачивания или ссылкой на страницу статьи. При этом если это ссылка для скачивания, то
ссылка должна иметь специальную иконку
3.3 Спецификация информации (спецификация данных)
3.3.1 Статья
Используется для отображения статической мало изменяемой информации. Например,
история компании, контакты. В теле может содержать форматирование и картинки.
Свойства:
1. Дата создания
2. Автор
3. Заголовок
4. Текст
5. Раздел сайта
3.3.2 Сотрудник
Свойства :
1. Фотография
2. ФИО — обязательно
3. должность — обязательно
4. подразделение
5. Описание (краткое выполняемых о обязанностей опыта и т. п.)
6. Телефон
7. skype
8. icq
9. e-mail
3.3.3 Новость
Свойства:
1. Дата создания
2. Автор
3. Заголовок — обязательно
4. Анонс
5. Текст новости — обязательно
6. Фотография
7. Раздел сайта (Новости)
3.3.4 Финансовый отчет
Отчет не является html странице, он храниться на сервере в виде файла формата doc, rtf, pdf и
отображается пользователю, как ссылка для скачивания данного файла
Свойства:
1. Раздел сайта (бухгалтерская отчетность, сведения о доходах, сведения о расходах )
2. Год — обязательно
3. Квартал
4. Месяц
5. Файл отчета — обязательно
6. Комментарии
3.3.5 Услуга
Свойства:
1. Название
2. Тип услуги
3. Описание услуги — текстовое описание услуги
4. Периодичность выполнения (ежедневно, еженедельно, ежемесячно, ежеквартально,
ежегодно)
5. результат выполнения — текстовое описание результата
6. гарантийный срок — текстовое описание
7. факторы определяющие выбор данной услуги для МКД — текстовое описание
8. стоимость
3.3.6
План работы
План работы как и отчет не является html странице, он храниться на сервере в виде файла
формата doc, rtf, pdf и отображается пользователю, как ссылка для скачивания данного файла.
План работ имеет период и всегда связан с одним МКД.
Свойства:
1. дата начала работ
2. дата окончания работ планируемая
3. дата окончания работ действительная
4. файл документа плана
5. МКД связанный с планом на указанный период
6. Состояние плана (создан, в работе, выполнен)
7. Отчет о выполнении плана
8. Комментарии
3.3.7 МКД
Свойства:
1. Адрес
2. Общая площадь
3. Дата заключения договора на обслуживание
4. Файл договора
5. Статус договора (действующий, расторгнут)
4 Структура шаблона
4.1 Регионы
Шаблон состоит из 5 основных регионов:
1. Шапка
2. левая панель
3. левая панель
4. Основной контент
5. Подвал
Общий вид и расположение регионов
Шапка
левая панель
Основной контент
Подвал
4.1.1 Шапка
Отображает

логотип

название компании

контактные телефоны

Визуальную заставку

главное меню
левая панель
4.1.2 Левая панель
Используется для отображения информационных блоков:

Последние новости

Финансовая отчетность

Документы
4.1.3 Правая панель
Используется для отображения рекламных блоков и банеров.
4.1.4 Основной контент
Кроме основного контента, содержит блок «Крошки», который отображает путь к
отображаемому контету. Каждая страница основного контента отображается в виде:
заголовок и тело контента .
4.1.5 Подвал
Содержит 3 блока:

Контактные данные: адрес, основной контактный телефон, e-mail и т.п.

Основные ссылки

Счетчик посещений и информация о создании сайта
4.2 Блоки
4.2.1 Последние новости
Блок выводится на всех страницах кроме: главная, новости и ее дочерние страницы.
Отображает в виде:
1. Заголовок блока
2. Список из заголовков 5-и последних добавленных новостей, каждый заголовок
является ссылкой на соотвествующую новость
3. Ссылка «Все новости» - для перехода на страницу «Новости»
4.2.2 Финансовая отчетность
Блок отображается на всех страницах в виде:
1. Заголовок блока
2. Список из заголовков 5-и последних добавленных отчетов в раздел (независимо от
подраздела ), каждый заголовок является ссылкой для скачивания соотвествуюющего
отчета
3. Ссылка «Подробнее» - для перехода на страницу «Финансовая отчетность»
4.2.3 Документы
Блок отображается на всех страницах в виде:
1. Заголовок блока
2. Список из заголовков 5-и последних добавленных документов в раздел (независимо
от подраздела ), каждый заголовок является ссылкой для скачивания соотвествующего
документа
3. Ссылка «Подробнее» - для перехода на страницу «Документы»
4.2.4 Основный ссылки
Отображает список ссылок главного меню в развернутом и уменьшенном виде
5 Система навигации по сайту
Система навигации должна состоять из:

Главного меню

Дополнительные блоки (описание блоков смотрите выше):
◦ Последние новости
◦ Финансовая отчетность
◦ Документы
◦ Основные ссылки
5.1 Главное меню
Структура меню:
1 О компании
1.5
История и структура компании
1.6 Контакты
1.7 Сотрудники
1.8 Реквизиты
2 Новости
3 Финансовая отчетность
3.1 Бухгал терская отчетность
3.2 Сведения о доходах
3.3 Сведения о расходах
4 Услуги и цены
4.1 Перечень услуг и стоимость
4.2 Планы и сведения о выполнении работ
5 Коммунальные ресурсы
6 Перечень МКД
7 Документы
7.1 Типовые договора
7.2 Правовая информация
Меню быть реализовано как горизонтальное выпадающее меню. Пункты содержащие
подменю должны иметь отличительный признак. Подменю открывается при наведении
курсора на корневой пункт меню.
6 Требования к наполнению контентом
При разработке и для демонстрации работоспособности сайта, он должен быть частично
наполнен контентом. Частично означает, что в каждом разделе, кроме раздела «О компании»,
создается по 3 информационных единицы. В качестве основы могут использоваться как свои
данные, так и информация предоставленная заказчиком. Отображение информации должно
полностью соответствовать описанному выше. Дочерние страницы раздела «О компании»
верстаются полностью.
7 Результат
По окончании заказчик работ получает:
1. сайт созданный согластно ТЗ, и частично наполненный контентом, согласно пункта
«Требования к наполнению контентом», с дизайном, согласно пункта «Требования к
интерфейсу».
2. инструкцию администратору по наполнению сайта, и изменению элементарных
настроек отображения информация (количество элементов в блоках и в таблицах)
3. после наполнения сайт является полностью функциональным и готов к публикации в
Интернет
Полное наполнение сайта контентом оговаривается отдельно.
8 Соглашения
1. В процессе разработки возможно внесение изменений в ТЗ, если они не влекут
изменений в структуре отображения и хранения информации. В противном случае
оформляется отдельно ТЗ, которое оплачивается отдельно.
2. Если происходят задержки со стороны заказчика (не получено подтверждение, нет
необходимых комментариев, не получен необходимый контент, не предоставлен
доступ к хостингу и т. п.), то сроки разработки на данном этапе увеличиваются на
время задержки.
9 Этапы и сроки
C учетом текущей ситуации наиболее важным является разработка функционала и
публикация сайта поэтому последовательность этапов такова:
1. Создание сайта согласно ТЗ без разработки дизайна и верстки 2 календарных недели
(срок с запасом скорее всего будет быстрее). Датой начала работ будет считаться
следующий день, после получения уведомления по почте (email) о полном
подтверждении ТЗ. Стоимость реализации без учета дизайна и верстки 20 000
рублей. По окончанию этапа я получаю указанную с сумму и приступаю к
следующему этапу.
2. Разработка дизайна и верстка шаблона согласно пункту «Структура шаблона» займет
от 2-х недель (зависит от того как быстро будет согласован дизайн). Стоимость
данного пункта 5 000 рублей, при этом в дизайн не содержит каких-либо
динамических элементов (анимация, flash, JS события и т. п.), все оформление сайта
статично (фотографии или фотоколаж). Если необходимо наличие динамических
элементов, то для дизайна составляется отдельное ТЗ, соответственно
устанавливаются сроки и цена.
Download