TatLeo (Все сообщения пользователя)

Добрый день! Процесс описания системы идет, и параллельно возникают некоторые вопросы. Один из них...
Одной из функций системы является некий процесс, который требуется описать. Точнее, нужно описать алгоритм его работы. И описать нужно достаточно подробно, не в двух словах "предназначен, как выполняется, что получается в итоге". Была нарисована диаграмма активности (блок-схема), которая отображает алгоритм. На диаграмме изобразила все условия, циклы и т.п. Вот теперь не знаю, в каком ключе вести описание... Например, по пунктам:
1. Если выполняется условие 1, идем по ветке "Да", иначе ветка "Нет".
2. Перешли в ветку 2, выполнили действие 1, действие 2 и т.п.
Не знаю, как принято описывать подобные алгоритмы. Может кто то сталкивался?  

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

Вот иду я с обеда и думаю... А зачем изобретать велосипед?! В тексте программы достаточно много комментариев, из которых все понятно. И  классы расписаны, и методы и параметры. Возьму комментарии и все! Лучше разработчика не сделаешь описание кода. По сути, цель задачи собрать в одно документацию по проекту.
Структуру всего документа я ведерживаю по ГОСТу

Возможно я неправильно сформулировала вопрос.
Структура раздела:
1 Диаграмма классов
(картинка)
1.1 Классы
1.2 Используемые методы
2 Диаграмма взаимодействия
(картинка и описание)
3 Входные данные
4 Выходные данные

Так вот именно с учетом текста программы, в каком стиле выдержать пункты 1.1, 1.2, 3, 4? Может быть у кого примеры есть? (Java).

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

Можно подробнее? Или, если есть шаблоны какие то, стандарты или ГОСТы, можно их посмотреть?

Сделано.

В процессе. Постоянно обращаюсь к соответствующей литературе.

Спасибо за полезную информацию! Учту

Возможно неправильно выразилась) Не так часто на форумах общаюсь

Спасибо за советы! Тема не закрывается, т.к. далее будет еще много вопросов. Так можно?

Спасибо за обсуждение! Начала с того, что строю диаграмму классов, далее диаграмму последовательностей. Во многом "для себя", чтобы понять как устроена система. Далее приступлю к созданию документа по ГОСТу.
Оказалось интересно, надеюсь справлюсь.

Ответы не затягиваются, с этим все в порядке. Беспокоюсь, что рано или поздно может наступить предел( И скажут, что задачу нужно было выполнить вчера

Да. Задача уже поставлена. Получается, что консультироваться с разработчиками придется постоянно. Модулей куча! Сейчас параллельно в работе три процесса: изучение основ ООП, Java и исходников. И беспокоит то, сколько разработчик будет отвечать на вопросы? Ведь чем глубже погружаешься в задачу, тем больше вопросов возникает. Возможно некоторые вопросы неоднократно.

Добрый день!
У компании есть готовый работающий проект. Необходимо по коду программы (Java) выполнить описание программы. За основу будет взят ГОСТ 19.402-78. Вопрос заключается в следующем: с какой стороны подойти к этому исходному коду, учитывая, что опыта программирования на Java нет? Т.е. параллельно нужно будет изучать Java  и основы ООП. Исходный код содержит множество модулей, как понять с какого начать описание?

Понятно

Как зайти в веб-мессенджер? По ссылке в правом верхнем углу форума открывается данная ветка.

Спасибо!

Тема актуальна? Есть ссылка на раздел?

Нашла некоторые шаблоны и ГОСТы буду изучать. Вопросы появятся позже. Спасибо!

Добрый день! Подскажите, пожалуйста, где можно посмотреть или взять пример/шаблон такого документа, как "Описание программы".