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.

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

128

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

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

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

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

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

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

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

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

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

129

мер, на рис. 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.

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

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

130

Глава 16. Ответы на комментарии и их обобщение

Процесс ответов на комментарии читателей называется реагированием. В этом процессе автор участвует после получения от библиотекаря папки с комментариями. В SADT упорядоченный процесс реагирования обеспечивает высокий уровень согласованности и компетентности для обратной связи автора с читательской аудиторией. Чтобы отреагировать на откомментированную папку, автор : (1) изучает каждое замечание читателя и отвечает на него, (2) принимает решение о необходимости диалога автор/читатель для обсуждения основных вопросов, (3) обобщает все комментарии на авторской копии папки, (4) переделывает диаграмму в соответствии с набором обобщенных замечаний.

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

16.1. Чтение и ответы на замечания

Вначале бегло просмотрите папку, отмечая замечания и фиксируя их количество. Вы получите представление о тех частях папки, которые в общем не вызывают сомнения, и о тех, к которым много претензий. Кроме того, посмотрите, сколько времени затратил читатель. Это позволит вам оценить, насколько трудно было комментировать папку. Продолжительность своей работы тоже отметьте на титульном листе. Просмотрев все замечания, вернитесь назад и ответьте на каждое из них. Старайтесь понять, что хотел сказать читатель. Сделайте вывод. Если вы согласны, поставьте галочку, если нет, поставьте крестик. Например, на диаграмме ЭМЦ/А2 (рис. 16-2) автор обозначил согласие с замечаниями 1-5 и несогласие - с замечанием 6.

Сделав пометку около замечания, добавьте, если нужно, пояснительный текст. Ответьте на вопрос читателя, объясните смысл или поясните, почему вы не согласны с его комментарием. Например, объяснение автора по поводу его несогласия с замечанием 6 на рис. 16-1 раскрывает различие между физическими деталями и информацией о частях изделия. При ответе на важный вопрос или изложении новой идеи, возникшей в процессе анализа комментариев, запишите синим цветом рядом с комментарием новое замечание "с кружком" и соедините его с комментарием зигзагом. Помещение новых замечаний в откомментированную папку вполне допустимо.

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

131

Рис. 16-1. Титульный лист и родительская диаграмма с ответами автора

132

Рис. 16-2. Диаграмма и дополнительный материал с ответами автора

133