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.

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

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

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

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

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

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

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

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

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