Настройки дизайна
  • Общие
  • Шапка
  • Главная
Базовый цвет
Свой цвет
Сайдбар
Тень на внутренних страницах
Фон логотипа в цвет сайта
Шапка сайта всегда видна
Шапка по ширине экрана
Кнопка "Оставить заявку" вместо слогана
Главное меню
Пункты меню 3-го уровня
Скрыть слайдер
"Услуги" на главной
"Тизеры" на главной
"Форма обратной связи" на главной
"Выполненные работы" на главной
"Новости" на главной
"Блог" на главной
"Партнеры" на главной

Обратное проектирование

Внимание! Мы обновляемся! 
@twriters obmen_soobsheniyami.pngчат для технических писателей в Telegram
 Зарегистрируйтесь
   RSS
Обратное проектирование
 
Добрый день!
У компании есть готовый работающий проект. Необходимо по коду программы (Java) выполнить описание программы. За основу будет взят ГОСТ 19.402-78. Вопрос заключается в следующем: с какой стороны подойти к этому исходному коду, учитывая, что опыта программирования на Java нет? Т.е. параллельно нужно будет изучать Java  и основы ООП. Исходный код содержит множество модулей, как понять с какого начать описание?
Страницы: Пред. 1 2
Ответы
 
Цитата
ADVANCED пишет:
Я бы порекомендовал:

Sierra K., Bates B. Head First Java, 2nd Edition / O'Reilly Media, 2005. - 688 pp.
перевод:
Сьерра К., Бейтс Б. Изучаем Java / пер. с англ., Эксмо, 2012 - 708 pp.


Schildt H. Java, A Beginner's Guide, 5th Edition / McGraw-Hill, Osborne Media, 2011. - 640 pp.
перевод:
Шилдт Г. Java. Руководство для начинающих (5-е издание) / Вильямс, 2012. - 626 c.

Bloch J. Effective Java, 2nd Ed. / Prentice Hall, 2008, 384 pp.
перевод:
Блох Дж. Java. Эффективное программирование / пер. с англ. М.:, Лори, 2014 - 461 с.
Изменено: Виктор Фигурнов - 31.01.2015 10:29:37
 
Цитата
Виктор Фигурнов пишет:
Цитата
ADVANCED пишет:
Я бы порекомендовал:

Sierra K., Bates B. Head First Java, 2nd Edition / O'Reilly Media, 2005. - 688 pp.
перевод:
Сьерра К., Бейтс Б. Изучаем Java / пер. с англ., Эксмо, 2012 - 708 pp.


Schildt H. Java, A Beginner's Guide, 5th Edition / McGraw-Hill, Osborne Media, 2011. - 640 pp.
перевод:
Шилдт Г. Java. Руководство для начинающих (5-е издание) / Вильямс, 2012. - 626 c.

Bloch J. Effective Java, 2nd Ed. / Prentice Hall, 2008, 384 pp.
перевод:
Блох Дж. Java. Эффективное программирование / пер. с англ. М.:, Лори, 2014 - 461 с.
Ага, вот как раз подобное перечислял и то ли браузер, то ли форум отвалился

В общем литературы много для начинающих
 
Добрый день! Один из разделов документа "Описание системы" это Описание логической структуры. В данный раздел добавлена диаграмма классов системы (правильно или нет?). К схеме необходимо добавить текстовое описание (правильно или нет?). Какой стиль изложения использовать? Что нужно отобразить в данном описании? Заранее спасибо!
 
Цитата
TatLeo написал:
Добрый день! Один из разделов документа "Описание системы" это Описание логической структуры. В данный раздел добавлена диаграмма классов системы (правильно или нет?). К схеме необходимо добавить текстовое описание (правильно или нет?). Какой стиль изложения использовать? Что нужно отобразить в данном описании? Заранее спасибо!

6. В разделе «Описание логической структуры» должны быть указаны:
алгоритм программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

Диаграммы классов недостаточно. Как минимум, необходимо сделать ещё диаграмму последовательности.
С учётом ссылки в ГОСТ на то, что описание должно быть выполнено с учётом текста программы, я бы ещё сделала описание физической структуры. На мой взгляд, описания физической структуры недостаточно.
techwriter.ru.com
 
Возможно я неправильно сформулировала вопрос.
Структура раздела:
1 Диаграмма классов
(картинка)
1.1 Классы
1.2 Используемые методы
2 Диаграмма взаимодействия
(картинка и описание)
3 Входные данные
4 Выходные данные

Так вот именно с учетом текста программы, в каком стиле выдержать пункты 1.1, 1.2, 3, 4? Может быть у кого примеры есть? (Java).
 
Не надо воспринимать ГОСТ 19.402-78 всерьез. Это безнадежно устаревшая писанина времен перфокарт и перфолент. А вы пытаетесь ее применить к языку Java, который был создан в 1990-е годы, и идеологию которого разработчики ГОСТа представить себе не могли. Поэтому пишите описание кратко и по собственному усмотрению. В любом удобном вам стиле. Если в организации уже есть какие-то описания программ, ориентируйтесь на их стиль. Нужно, чтобы ваше описание было понятно, чтобы рубрики, указанные в ГОСТе, в нем присутствовали, и то, что для этих рубрик велено указывать, было указано. Этого вполне достаточно.  
 
Цитата
techwriter написал:
я бы ещё сделала описание физической структуры. На мой взгляд, описания физической структуры недостаточно.

Описание физической структуры в этом документе приводить не следует. И других конкретных деталей реализации программы тоже.
 
Цитата
Виктор Фигурнов написал:
Не надо воспринимать ГОСТ 19.402-78 всерьез. Это безнадежно устаревшая писанина времен перфокарт и перфолент. А вы пытаетесь ее применить к языку Java, который был создан в 1990-е годы, и идеологию которого разработчики ГОСТа представить себе не могли. Поэтому пишите описание кратко и по собственному усмотрению. В любом удобном вам стиле. Если в организации уже есть какие-то описания программ, ориентируйтесь на их стиль. Нужно, чтобы ваше описание было понятно, чтобы рубрики, указанные в ГОСТе, в нем присутствовали, и то, что для этих рубрик велено указывать, было указано. Этого вполне достаточно.
Вот иду я с обеда и думаю... А зачем изобретать велосипед?! В тексте программы достаточно много комментариев, из которых все понятно. И  классы расписаны, и методы и параметры. Возьму комментарии и все! Лучше разработчика не сделаешь описание кода. По сути, цель задачи собрать в одно документацию по проекту.
Структуру всего документа я ведерживаю по ГОСТу
Изменено: TatLeo - 03.02.2015 14:07:11
 
Цитата
TatLeo написал:
А зачем изобретать велосипед?! В тексте программы достаточно много комментариев, из которых все понятно. И  классы расписаны, и методы и параметры. Возьму комментарии и все! Лучше разработчика не сделаешь описание кода. По сути, цель задачи собрать в одно документацию по проекту.
Структуру всего документа я ведерживаю по ГОСТу
Читать текст программы и разбираться в комментариях - долго и неудобно. Особенно если программа большая. И часто комментарии относятся к деталям реализации. Вы же должны сделать краткий документ, описывающий назначение программы, входные и выходные данные, требуемые ресурсы и т.п. Чтобы читатель смог быстро получить представление о назначении, возможностях и условиях применения программы. В этом описании не должно быть конкретных деталей реализации, они могут меняться.
 
Сейчас мне нужно описать классы и методы, с этим в комментариях все в порядке. Тем более (даже могу похвалиться), я уже ориентируюсь в исходном коде.
Структура документа одобрена моим руководителем, пока придерживаюсь этой структуры. Возможно, в дальнейшем, про мере вникания в предметную область, что то поменяется.
 
Цитата
TatLeo написал: В тексте программы достаточно много комментариев, из которых все понятно. И  классы расписаны, и методы и параметры. Возьму комментарии и все!
Помню даже была какая то программа, которая тексты комментариев собирала в Руководство пользователя (ну относительное, конечно, руководство), вытягивала комментарии из кода очень здорово
Торопливость в выводах может привести к неприятностям
 
Добрый день! Процесс описания системы идет, и параллельно возникают некоторые вопросы. Один из них...
Одной из функций системы является некий процесс, который требуется описать. Точнее, нужно описать алгоритм его работы. И описать нужно достаточно подробно, не в двух словах "предназначен, как выполняется, что получается в итоге". Была нарисована диаграмма активности (блок-схема), которая отображает алгоритм. На диаграмме изобразила все условия, циклы и т.п. Вот теперь не знаю, в каком ключе вести описание... Например, по пунктам:
1. Если выполняется условие 1, идем по ветке "Да", иначе ветка "Нет".
2. Перешли в ветку 2, выполнили действие 1, действие 2 и т.п.
Не знаю, как принято описывать подобные алгоритмы. Может кто то сталкивался?  
 
Цитата
1. Если выполняется условие 1, идем по ветке "Да", иначе ветка "Нет".
2. Перешли в ветку 2, выполнили действие 1, действие 2 и т.п.
Не знаю, как принято описывать подобные алгоритмы. Может кто то сталкивался?

Думаю, просто дублировать словами схему не стоит. Нужно дать пояснения текстом к наиболее сложным частям алгоритма (если он большой), ну и раскрыть смысл переменных, если они в нём используются. В общем описание должно быть человеческим, ну как в учебниках по программированию, а не чисто формальным.
Страницы: Пред. 1 2
Читают тему
Рейтинг@Mail.ru