Методологія структурного аналізу і проектування SADT. Глава 15, Комерція, Різне, статті

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



У міру читання 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
































































Код Формат Значення
3 Блок Блок 3
5 Зауваження Зауваження 5
01 Вершина дуги Гранична дуга
312 Блок + вершина дуг Друга вхідні
  . дуга блоку 3
Дивись
Е.2 Сторінка + блок На стр.Е см. блок 2
A.I Сторінка + зауваження На діаграмі А
    см. зауваження 1
А42.3 Діаграма + блок На діаграмі А42
    см. блок 3
В.401 Сторінка + вершина дуги На стор В см.
    перші вихідні
    дугу блоку 4

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.


Схожі статті:


Сподобалася стаття? Ви можете залишити відгук або підписатися на RSS , щоб автоматично отримувати інформацію про нові статтях.

Коментарів поки що немає.

Ваш отзыв

Поділ на параграфи відбувається автоматично, адреса електронної пошти ніколи не буде опублікований, допустимий HTML: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

*

*