Русский / English
Цель проекта – разработка техник повторного использования документации. Не секрет, что, например, большие технические задания, размером в сто страниц и более, содержат огромное количество повторов. Многочисленные повторы содержатся также в API-документации, в руководствах программистам и пр. документах программных проектов. Причина этого – в активном использовании copy-pasting при разработке и модификации документов. Неуправляемые повторы существенно затрудняют поддержку документации, поскольку при внесении изменений надо гарантировать, что вся раскопированная информация также будет надлежащим образом изменена. Организация планового повторного использования, основанная на формальных методах, поможет использовать повторы для унификации документов и решит вопрос с синхронным изменением повторяющейся информации в больших документах.
При этом повторное использование документации оказывается возможным, поскольку в настоящее время активно используются так называемые markup-языки для разработки документов, в частности, DocBook. Эти языки подразумевают создание документа как специальной программы, в которой специфицируется разметка документа (разделы, заголовки и пр.), а также сам контент. Использование markup-языков все прочнее входит в жизнь профессиональных технических писателей, в то время как средства наподобие Microsoft Word используются лишь для небольших документов.
Создан метод повторного использования документации. Метод поддерживает формат DocBook. Созданы средства рефакторинга документации, подразумевающие сохранение внешнего вида и изменения внутреннего представления документации. Реализован программный инструмент Docline (Java/Eclipse). Скачать исходный код инструмента можно здесь.
Создан подход к поиску и анализу повторов в документации. Реализован алгоритм поиска нечетких повторов на основе поиска клонов в ПО. Создан прототип алгоритма поиска нечетких повторов на основе N-gram модели. Создан интерактивный поход к анализу нечетких повторов и выделению семантически значимых повторов. Реализован программный инструмент Duplicate Finder, поддерживающий визуализацию и анализ нечетких повторов (Python). Более подробная информация по поиску нечетких повторов и исходному коду инструмента находится здесь.
Научный руководитель проекта | Дмитрий Кознов | dkoznov [at] yandex.ru |
Технический руководитель | Дмитрий Луцив | dluciv [at] math.spbu.ru |
Год | Автор | Название | Скачать |
---|---|---|---|
2010 | Романовский Константин Юрьевич, к.ф.-м.н. | Метод повторного использования документации семейств программных продуктов |