Движение за открытую проектную документацию

Linux Summit 2004, Хельсинки

Движение за открытую проектную документацию

Анатолий Шалыто[email protected]

Кафедра “Компьютерные технологии”Санкт-Петербургский государственный университет

информационных технологий, механики и оптики

Движение за открытую проектную документацию — http://is.ifmo.ru 2


Проектная документация (1)

Должнобыть хоро-

шо докумен-тировано

Управлениеответствен-

нымиобъектами

Остальное

Коммерческое

Остальное

Документи-ровано вобъеме,

требуемомзаказчиком

?Образова-

тельное

Программное обеспечение

НекоммерческоеСовместное использование

коммерческого и некоммерческогопрограммного обеспечения

Документи-ровано по

усмотрениюразработ-

чика

Должнобыть хоро-

шо докумен-тировано



Проектная документация (2) Коммерческие проекты

Управление ответственными объектами Основная – по стандартам Дополнительная – по требованию заказчика

Остальные По требованию заказчика

Некоммерческие проекты Образовательные

Качественная Остальные

По желанию разработчика



Документация на аппаратуру и документация на ПО

Аппаратуру проектируют одни люди, а изготавливают другие

Документация на аппаратуру Проектная документация Основные проектные

решения Результаты приемки Руководство

пользователя

Программное обеспечение проектируют и изготавливают одни и те же люди

Документация на программное обеспечение Руководство

пользователя Руководство

разработчика Исходный код (для

проектов с открытым исходным кодом)



Открытая проектная документация

Почему проектная документация? Качество проекта повышается Верификация упрощается Модификация становится легче и безопаснее

Почему открытая проектная документация? Открытая проектная документация добавляет свободу Понимание проекта упрощается Становится возможным использование проектных

решений, разработанных ранее и другими людьми Становится возможным применять проекты для

обучения студентов специалистов



Почему открытая проектная документация?

Открытая = Должна быть доступна для дальнейшего использования

Движение за открытую проектную документацию – свободное, однако находится в другой плоскости по сравнению с Движением за свободное программное обеспечение (Free Software Foundation) или Движением за открытые исходные коды (Open Source Foundation) Результаты и идеи Движения за открытую

проектную документацию могут быть применены не только к свободному программному обеспечению, но и к коммерческому, секретному и другим видам программного обеспечения



Документация на программное обеспечение

В инженерной практике проектов без проектной документации не бывает На www.sourceforge.net – не 76000 проектов, а

значительно меньше Код должен основываться на проектной

документации, а не наоборот Документация должна описывать не

только конечный продукт, но и процесс его создания

http://www.sourceforge.net/



SWITCH-технология Автоматное программирование

Предложено в 1991 году Основано на явном выделении состояний Проектирование, управляемое моделями Область использования – системы со

сложным поведением Может использоваться на различных

аппаратных платформах Программируемых логических контроллерах Микроконтроллерах Микропроцессорах



РазновидностиSWITCH-технологии

Логическое управление Процедурное программирование с явным

выделением состояний Объектно-ориентированное

программирование с явным выделением состояний

Классические вычислительные алгоритмы



Основные понятия SWITCH-технологии

Состояние Совокупность состояний

Входные переменные + События = Входные воздействия Состояния + Входные воздействия = Автоматы без выхода Автоматы без выхода + Выходные воздействия = Автоматы

Многозначное кодирование состояний Наблюдаемость по состояниям Система взаимосвязанных автоматов Протоколирование Проектная документация



Автоматы в автоматном программировании

Средства спецификации алгоритмов Изоморфное отображение в исходный код Программа работает и протоколируется в

терминах автоматов



Образовательный эксперимент (1)

Кафедра компьютерных технологий СПбГУ ИТМО Избранные студенты со всей России Медалисты международных олимпиад по

информатике Медалисты чемпионата мира по

программированию




1998-2001 Обычное образование 1 Лекции и экзамены

2001-2002 Обычное образование 2 Лекции, курсовые работы и экзамены

2002-2003 Экспериментальное обучение Лекции и проекты Создание подробной проектной документации Более 40 полностью выполненных проектов

Эксперимент продолжается




Состав проекта Проектная документация (не менее 60 часов)

Описание задачи Описание интерфейса пользователя Принятые проектные решения Описания автоматов и классов Схемы автоматов и классов Протоколы проверки Список литературы

Исходный код (не менее 20 часов) Анатолий Шалыто тратит около 10–15 часов на проект



Примеры проектов

Игры Скелетная анимация Управляющие системы Графические интерфейсы пользователя Параллельные задачи Транслитерация Многое другое



Три примера

Моделирование дизель-генератора Процедурное программирование

Программа для игры RoboCode Объектно-ориентированное

программирование Технология разработки визуализаторов

Объектно-ориентированная визуализация вычислительных алгоритмов



Дизель-генератор План выполнения проекта

Анализ Структурирование (выделение автоматов) Схема взаимодействия автоматов Словесное описание автоматов Схема связей автомата (интерфейс) Графы переходов Изоморфное построение исходного кода Проверочные протоколы



Дизель-генераторСхема взаимодействия автоматов



Дизель-генераторСхема связей автомата



Дизель-генераторГраф переходов автомата



Дизель-генераторИзоморфный исходный код

void A0(int e, dg_t *dg) { int y_old = dg->y0; switch(dg->y0) { case 0: A8(e, dg); if (x220(dg)) dg->y0 = 4; else if (dg->y7 == 2) dg->y0 = 7; else if (dg->y8 == 2) dg->y0 = 1; break; case 1: A4(e, dg); A3(e, dg); A1(e, dg); if (dg->y4 != 0) dg->y0 = 6; else if (dg->y7 == 2 || dg->y7 == 4) dg->y0 = 8; else if (dg->y3 != 0) dg->y0 = 5; else if (dg->y1 == 0) dg->y0 = 0; else if (dg->y1 == 3) dg->y0 = 7;

…



Дизель-генераторПротоколы



Программа для игры RoboCodehttp://robocode.alphaworks.ibm.com

Лучшие результаты1. GlowBlowMelee 1.1 2. Cigaret 1.20 3. Cynical4. GlowBlow 5. Cynical_3

http://robocode.alphaworks.ibm.com/





Программа для игры RoboCodeПлан выполнения проекта

Анализ Структурирование (выделение классов) Диаграмма классов Все этапы из плана реализации проекта

дизель-генератора



Программа для игры RoboCode Диаграмма классов



Программа для игры RoboCode Схема структуры класса



Программа для игры RoboCode Интерфейс автомата



Программа для игры RoboCode Граф переходов



Программа для игры RoboCode Отладка по протоколам



Технология разработки визуализаторов

АлгоритмМалхотра,

Кумара,Махешвари

поискамаксимального

потока



Технология разработки визуализаторовСтруктура визуализатора

Модель Система взаимосвязанных автоматов,

сгенерированная по XML–описанию Вид

Интерфейс пользователя, основанный на библиотеке Vizi

Контроллер Библиотека Vizi



Технология разработки визуализаторов Проектная документация (1)

Аннотация Введение Глава1. Анализ литературы Глава 2. Описание алгоритма Глава 3. Реализация алгоритма Глава 4. Описание модели данных Глава 5. Преобразование реализации Глава 6. Описание интерфейса



Технология разработки визуализаторов Проектная документация (2)

Глава 7. Описание конфигурации Заключение Список литературы Приложения

Реализация алгоритма Преобразованная реализация XML–описание визуализатора Сгенерированные исходные коды Код интерфейса пользователя



Визуализированные алгоритмы

Алгоритм Малхотра, Кумара, Махишвари Алгоритм Диница Алгоритм Хопкрофта-Крапа Минимальное дерево путей Алгоритмы на 2–3 деревьев Битоническая задача коммивояжера Алгоритм Укконена Алгоритм Прима Алгоритм построения простых строк и циклов де

Брюина



Ссылки

Примеры проектов http://is.ifmo.ru/?i0=projects – Проектная

документация http://is.ifmo.ru/?i0=works – Статьи http://unimod.sourceforge.net/ – Проект UniMod

(на английском)

http://is.ifmo.ru/?i0=projects

http://is.ifmo.ru/?i0=works

http://is.ifmo.ru/?i0=works

http://unimod.sourceforge.net/

Движение за открытую проектную документацию

Documents