Методология структурного анализа и проектирования SADT. Глава 15

Глава 15. Конструктивное комментирование

• 15.1. Запись о продолжительности работы
• 15.2. Проверка заполнения полей бланка диаграммы
• 15.3. Обозначения согласия и несогласия с автором
• 15.4. Замечания
• 15.5. Язык ссылок SADT
• 15.6. Повторное чтение папки
• 15.7. Конструктивная критика
• 15.8. Резюме
• Дополнительная литература

По мере чтения SADT-диаграмм следует фиксировать возникающие проблемы. В SADT принят следующий порядок для записи этих проблем, который называется комментированием: (1) сделать запись о продолжительности времени работы, (2) проверить правильность заполнения полей бланка, (3) использовать по мере необходимости простые обозначения согласия или несогласия с автором, (4) использовать поля "Замечания" для записи существенных и конструктивных комментариев, (5) использовать по возможности язык ссылок SADT, (6) еще раз прочитать папку перед возвращением ее автору. Теперь мы обсудим технику SADT-комментирования и как сделать комментарии эффективными и конструктивными.

Прежде чем перейти к обсуждению этих вопросов, следует отметить один важный момент. SADT рассматривает комментарии как самостоятельное понятие, отличное от самой диаграммы. Представьте себе, что комментарии пишут на прозрачном куске пластика, помещаемом поверх диаграммы, иными словами - комментарии - это покрытие, накладываемое на диаграмму читателем. Их никогда не следует интерпретировать как часть исходной диаграммы. SADT требует использования красного цвета для всех пометок при комментировании с тем, чтобы они отличались от самой диаграммы (на всех рисунках этой книги вместо красного цвета используется светло-серый). На рис. 15-1 и 15-2 приведена полностью откомментированная папка. Обратите внимание, что комментарии наложены поверх исходной графики и текста.

15.1. Запись о продолжительности работы

В SADT рекомендуется каждому читателю записывать время, затраченное им на чтение и комментирование папки. Это позволяет вести хронометраж, совершенствовать свои навыки, оценивать сложность папки и получать представление о затратах времени, необходимых для выполнения оставшейся работы. Запишите красным цветом время начала и окончания работы над папкой в области специальных инструкций титульного листа. Мы особенно рекомендуем фиксировать продолжительность работы, если вы только начинаете применять SADT. Делая это, вы заметите стабильное сокращение времени, затрачиваемого вами, новым пользователем SADT, на обработку папки. Потом продолжительность работы будет колебаться в пределах 20 минут в зависимости от сложности папки.

15.2. Проверка заполнения полей бланка диаграммы

Проверка заполнения полей бланка диаграммы не занимает много времени. Вначале проверьте фамилию автора, название проекта, дату создания и исправления, а также С-номер, чтобы отличить эту диаграмму от других. Например, диаграмма ЭМЦ/А2 на рис. 15-2 построена для проекта экспериментального механического цеха (ЭМЦ) 25.03.93 и ее С-номер -DAM010. Затем проверьте контекстный блок, название и номер узла, чтобы определить место диаграммы в модели. Диаграмма выполнить задание является декомпозицией второго блока своего родителя и находится на уровне А2 модели экспериментального механического цеха. Далее проверьте поле статуса, чтобы определить уровень полученной диаграммы. Например, диаграмма выполнить задание является просто диаграммой "Рабочая версия" и, следовательно, она почти или совсем не подвергалась рецензированию. В заключение поместите свои инициалы и дату рецензирования в поле "Читатель". Если вы всегда будете с этого начинать, то скоро станете делать это автоматически.

Рис. 15-1. Титульный лист и родительская с комментариями рецензента

Рис. 15-2. Диаграмма и дополнительный материал с комментарием рецензента

15.3. Обозначения согласия и несогласия с автором

Свое согласие с автором показывайте красной галочкой, несогласие - красным крестом. Обычно эти пометки используются для краткого комментирования конкретной части диаграммы или авторского замечания. Например, управляющая дуга блока 2 диаграммы ЭМЦ/А2 отмечена галочкой, потому что читатель согласился с тем, что только указания определяют выбор инструмента. А метка входа блока 2 была зачеркнута в знак несогласия читателя с выбором имени для этой дуги. Каждая диаграмма и страница дополнительного материала должны быть отмечены по крайней мере галочкой или крестом. Эти пометки говорят автору о том, что они были прочитаны и что читатель либо согласен, либо не согласен с изложенным. Однако мы рекомендуем давать на каждой диаграмме или странице папки более содержательные комментарии.

15.4. Замечания

В SADT существенные комментарии записываются в виде замечаний "с кружком". Чтобы сделать такое замечание, нужно: (1) жирно перечеркнуть очередной номер замечаний, (2) записать этот номер и обвести его кружком, (3) около обведенного номера записать содержание замечания и (4) при необходимости соединить зигзагом свое замечание с соответствующей частью диаграммы. Присваивая замечаниям номера, вы даете каждому из них уникальный идентификатор. Обводя номера кружком, вы отличаете свои замечания от замечаний автора, которые тоже могут быть на этой странице. Соединяя зигзагом замечания с соответствующей частью диаграммы, вы точно указываете, к чему они относятся. Например, диаграмма выполнить задание (рис. 15-2) получила шесть замечаний читателя. Обратите внимание, что зигзаг замечания б обводит две дуги, указывая, что это замечание относится к обеим дугам. Замечания 4 и 5 относятся к одному вопросу. Одно является поправкой, а другое - объяснением.

SADT различает замечания "с кружком" и "с квадратом". Замечания "с кружком" записываются на диаграмме авторами и читателями во время цикла автор/читатель. Поэтому они могут быть как красными, так и синими. Замечания "с квадратом" вводятся в исходную диаграмму автором обычно для того, чтобы что-то подчеркнуть на ней. Поэтому замечания "с квадратом" являются неотъемлемой частью диаграммы. Они всегда пишутся черным цветом и редко встречаются в модели. Обратитесь к моделям, приведенным в части VI, чтобы посмотреть, как замечания "с квадратом" используются для указания ключевых моментов.

15.5. Язык ссылок SADT

Избыток текста затрудняет чтение диаграммы и понимание ее смысла. То же самое справедливо и для замечаний. Поэтому в методологии SADT для упрощения замечаний существует язык ссылок. Язык ссылок помогает идентифицировать конкретный блок, дугу или замечание. Код ссылки составляется из номера узла диаграммы или буквенного обозначения страницы папки и ICOM-кода или номера замечаний. ICOM-коды используются для ссылок на определенные дуги конкретного блока. В табл. 15-1 приведены некоторые примеры.

Язык ссылок полезен также при написании текста к диаграмме. Например, описание основного пути потока данных на диаграмме выполнить задание, сделанное в разделе 14.2.3 обычным языком, могло бы быть записано с использованием языка ссылок SADT так: С1 к 1С1 к 102 к 2С1 и ЗС1 и 4С1, и т. д. до тех пор, пока не будет 401 к 112.

Поскольку такие обозначения очень компактны, часто можно видеть, как английский текст на обычном языке сопровождается взятым в скобки выражением на языке ссылок, которое уточняет движение по диаграмме. Мы рекомендуем применять язык ссылок после того, как вы и ваша читательская аудитория освоите остальную частью цикла автор/читатель. Однако не исключено, что вы захотите использовать язык ссылок уже в середине работы над вашим первым SADT-проектом.

15.6. Повторное чтение папки

После комментирования рабочих материалов, содержащихся в папке, разумно вернуться назад и перечитать их. Это не пустая работа. Как и другие письменные материалы, первые наброски редко сразу годятся для публикации. Поэтому, просматривая свои комментарии, вы можете отметить важные замечания галочкой, зачеркнуть ненужные, уточнить неясные, добавить новые замечания и кратко изложить рецензию на титульном листе. Только в редких случаях рецензию в ходе перечитывания нельзя улучшить. Наш опыт показывает, что качество рецензии резко повышается, если потратить пару минут на повторный просмотр всей папки

Таблица 15-1. Примеры языка ссылок SADT

15.7. Конструктивная критика

Никто не любит, когда его работу критикуют, не предлагая ничего взамен. SADT настоятельно рекомендует позитивный и конструктивный стиль комментирования. Конструктивные комментарии коротки, ясны, позитивны и конкретны. Например, замечания 4 и 5 на рис. 15-2 не только позволяют исправить ошибку автора, но и поясняют, почему исходная метка дуги неверна.

Особенно важно оказать помощь, если автор допустил серьезный просчет, неправильно понял основную терминологию или построил диаграмму, не отвечающую цели или точке зрения модели. В таких случаях мы советуем сделать на титульном листе замечание, описывающее ситуацию так, как вы ее видите, и предложить автору встретиться для обсуждения проблемы. В течение последующего диалога автор/ читатель используйте папку в качестве перечня вопросов для встречи и рассмотрите спорные вопросы в порядке номеров замечаний. Папка поможет вам сфокусировать тему беседы и сократить время встречи.

Опытные SADT-читатели не останавливаются в случае, если они не находят ошибок. Их задача тогда отметить все верное. Таким образом можно обнаружить пропуски важных моментов, неуместность отдельных частей диаграммы, неверную точку зрения или неправильно понятую цель. Вот почему хорошее нужно указывать так же, как плохое. Авторы должны знать, что они на верном пути, даже если есть недочеты. Например, на рис. 15-2 в замечании к дуге оборудованное рабочее место содержится похвала автору за верное понимание предмета рассмотрения и выразительное название.

Квалифицированные SADT-читатели вкладывают максимально возможное в свои комментарии. Лучше всего для комментариев использовать графический язык SADT. С его помощью читатель может быстро исправить синтаксис, предложить другие метки, направить дуги к другим блокам и рекомендовать другие декомпозиции. Используйте графику всегда, когда это возможно, потому что "меньше слов" часто означает "больше информации". На рис. 16-3 приведен пример графического замечания.

15.8. Резюме

Запись возникающих по ходу чтения проблем называется комментированием. Комментирование требует умения. Читатели должны давать только конструктивные комментарии, т.е. направленные на исправление диаграммы. Комментарии пишутся прямо на страницах папки красным цветом. Обозначения согласия и несогласия с автором, язык ссылок и графический язык SADT облегчают процесс комментирования и ссылки к отдельным частям диаграммы. Нумерация замечаний позволяет отслеживать комментарии и последовательность их написания.

Дополнительная литература

Elbow, P.: Writing with Power, Oxford University Press, Oxford, England, 1982.

Freedman, D., and Weinberg, G.: "Reviews, Walkthroughs, and Inspections", IEEE Transactions on Software Engineering, vol. 10, no. 1, January 1984.

Freedman, D., and Weinberg, G.: "Walkthroughs, Inspections, and Technical Reviews", Little Brown, Boston, 1982.

Macnamara, J.: Names of Things, MIT Press, Cambridge, Mass., 1982.

O'Rourke, J.: "Writing for the Reader", DEC, 1976.

SofTech, Inc.: "IDEFO Forms and Procedures Guide", SofTech Deliverable no. 7500-11, September 1979.