ИТМ_1 курс_заочникам / Описание проектных решений (правила оформления реферата)

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

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

4. Сообщения. Описываются все сообщения, выдаваемые пользователю в ходе выполнения программы, и действия, которые необходимо предпринять по этим сообщениям. Последовательность описания сообщений может быть «привязана» к последовательности работы с программой. Текстовые сообщения могут быть изложены в текстовой форме. Графические сообщения (панели, меню, выходные формы – графики, рисунки, диаграммы, документы и др.) следует приводить в форме, в точности соответствующей исходной. При необходимости приводятся поясняющие примеры. Все сообщения должны быть привязаны к сценарию диалога, представленному в виде графа в методической части отчета.

Ощутить разницу между описанием программы и описаниемпримененияпомогаетследующееправило: описаниепрограммы– этовзгляднапрограмму«изнутри», сточкизренияееразработчика и усовершенствующего ее программиста, описание применения – это взгляд «снаружи», с точки зрения пользователя.

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

61

понентов, участвующих при редактировании.

В отчете следует приводить только те тексты, которые написанынепосредственноавторомотчета, анесгенерированыразличнымисистемамиавтоматизированногопроектирования, типа Delphi или Power Designer. Объемные тексты обычно выносят в приложение. Распечатывать текст программы можно более мелким, чем в основном тексте отчета, шрифтом (но не меньше 10).

Зачастуюработоспособность созданногоПОдемонстрируется в отчете в виде контрольных примеров. Для их выполнения и описания ЕСПД предусматривает специальный документ –

Программа и методика испытаний, в который сводятся требова-

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

цель испытаний;

требования к программе – требования, заданные в техническом задании и подлежащие проверке во время испытаний;

средства и порядок испытаний – технические и программ-

ные средства, используемые во время испытаний, а также порядок проведения испытаний;

методы испытаний – описание используемых методов испытаний, описания проверок с указанием результатов проведения испытаний (перечней тестовых примеров, контрольных распечаток тестовых примеров и т.п.).

3.3 Описание базы данных

При описании баз данных (БД) в отчете должна быть приведена ее концептуальная и физическая схемы. Концептуальная схема должна отображать сущности, атрибуты, ключи, связи и их мощности. Обычно концептуальная схема изображается в нотации Баркера или Чена и строится с помощью пакетов Power Designer, ERWin, Visio и других CASE-средств. В таблице 9 при-

ведена номенклатура символов для изображения концептуальной схемы в нотации Баркера в пакетах Power Designer и ERWin. В таблице 10 показаны символы нотации Чена.

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

62

ды от одного выходного сообщения к другому (рисунок 13). Эти переходы могут быть управляемыми системой или пользователем. В последнем случае дуги изображают входные сообщения пользователя и могут быть помечены.

При описании отдельных элементов диалога – входных и выходных сообщений, панелей, меню, полей ввода-вывода – необходимо «привязываться» к сценарию и приводить их внешний вид и синтаксис.

3.5 Язык и стиль отчета 3.5.1 Об используемых терминах

Одна из основных неприятностей, с которыми сталкивается читатель, – терминологическая путаница, вносимая, в основном, методической частью. И дело здесь не только в некорректном использовании терминов. Простой пример: известно, что понятия «файл», «таблица», «тип сущности», «сущность», «объект», «отношение» хотя и происходят из разных дисциплин, но как структурные информационные элементы означают практически одно и то же.

Несмотрянаэтоавторнекойинформационнойсистемы, содержащей базу данных, начнет ее описание с расхожего определения, что реляционная база данных – это совокупность отношенийили, прощеговоря, таблиц. Описываяпредметнуюобласть, наш автор отметит, что накопленная информация систематизирована и сведена в картотеку, которую необходимо «автоматизировать». Разработка концептуальной схемы предметной области потребует использования такого понятия как сущность (именно этим термином пользуются авторы методов структурирования информации), которое впрочем мгновенно забудется в следующемразделе, посвященномописаниюпрограммы, – практическивсеязыкиоперируютпонятием файл илитаблица. Именно этот термин и станет окончательным и будет предъявляться пользователю системы во всех справочных материалах и меню.

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

66

го работать с картотекой и вынужденного постигать непонятное ему слово «файл».

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

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

3.5.2 О стиле изложения

Tекст отчета не должен содержать грамматических и орфографических ошибок. За многие годы работы в комиссиях почтинакаждойзащитеавторамэтогопособияприходитсявыслушивать чуть ли не с гордостью произносимые слова: «У меня всегдабылитрудностисграмотнымписьмом», закоторымиподразумевается, что главное – качество работы, а отчет, и уж тем более язык не имеют никакого значения. Не тешьте себя подобными оправданиями. Полуграмотный и косноязычный текст – не более чем проявление халтуры, лени и бескультурья, а некультурный человек не может сделать хорошую работу!

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

67

сделано ...» или «в ходе работы были получены ...» и т.п. [18]. Необходимо стремиться к максимальному сжатию материала, исключению из него лишнего, сомнительного и несущественного. Весь материал должен приводиться именно там, где он нужендляпониманиясмыслаотчета. Крайнююосторожностьнужно проявлять при заимствовании текстов из интернета. Как правило, эти тексты не проходят никакой корректуры и литературной обработки, а зачастую составляются не очень грамотными людьми. Помещая такой текст в свой отчет, Вы сильно рискуете.

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

Строгий научно-технический стиль изложения формируется годами. Этот процесс можно ускорить, используя наработанный опыт, например, набор шаблонов, позволяющих организоватьтекст, связатьеговединоепоследовательноеизложение. Приведемпереченьтакихлексическихконструкций, описанныхв[20].

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

Для выражения временной соотнесенности и порядка изло-

жения: сначала, прежде всего, в первую очередь, первым (последующим, предшествующим) шагом, одновременно, в то же время, здесь же, наряду с этим, предварительно, ранее, выше, еще раз, вновь, снова, затем, далее, потом, ниже, вдальнейшем, впоследующем, впоследствии, во-первых, во-вторых и т.д., в настоящее время, до настоящего времени, в последние годы, за последние годы, наконец, в заключение.

Для сопоставления и противопоставления: однако, но, так же, как и..., не только, но и..., по сравнению, в отличие, в проти-

68

Написание смысловых элементов можно выполнять параллельно: с одной стороны, формировать методологический и методический разделы, а с другой – документировать результат. Однако предпочтение все же необходимо отдавать первым двум разделам, т.к. именно они определяют структуру и последовательность изложения результата. Введение, как правило, бывает «привязано» в смысловом отношении к методологическому разделу, а заключение – к результату, поэтому за них следует братьсятолькопоокончаниисоответствующихразделовотчета. Текст заключения необходимо детально обсудить с руководителем.

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

1. Иногдавыясняется, чтообозначениекакой-либоперемен- ной, вносимоевсписокобозначений, ужебыло использовано ранее. В этом, конечно, нет ошибки, особенно, если такое обозначениедляэтихпеременныхявляетсяобщепринятым. Однакопри наличии возможности различать эти переменные, их необходимо «развести» переменные по разным именам. После такой корректировки обозначений основная часть потребует доработки.

2. Аналогичная история может случиться и с терминами. Вводяопределенныйтермин, необходимопроверить, чтобывезде в тексте отчета он употреблялся и интерпретировался одинаково и, наоборот, чтобы понятия, похожие на него по смыслу, назывались этим термином.

3. Значительных правок в тексте отчета требует введение аббревиатур. Зачастую идея ввести ту или иную аббревиатуру приходит не сразу, а после 5-6 повторений одного и того же словосочетания. Вводя аббревиатуру, необходимо проанализировать весь предыдущий текст на предмет замены этого словосочетания и помещения первой расшифровки аббревиатуры.

4. Часто в конце работы автор решает упорядочить список литературы по алфавиту, вследствие чего измененяется нумерация источников и ссылки на них в тексте отчета.

70