19

Спецификации

Составление спецификаций программного обеспечения

В этой главе:

•Зачем нужны спецификации

•Типы спецификаций

•Что в них содержится

•Почему их игнорируют?

Не было у меня таких тревог, которые не улеглись бы после чтения в течение часа.

Шарль Монтескье

Практически все, чем вы пользуетесь, имеет документацию. У вашего DVD%плеера есть инструкция по эксплуатации. У вашей ма% шины есть руководство по обслуживанию. В контракте есть текст, набранный мелким шрифтом. У шоколадного торта есть рецепт. Есть книги и журналы, посвященные прак% тически любым задачам, которые могут воз% никнуть. Если ваше программное обеспече% ние представляет собой какую%то ценность, у него тоже должна быть хорошая докумен% тация.1

Мы все знаем, что тщательно протестиро% ванное программное обеспечение, которое

1Разумеется, это не оправдание для плохого интерфейса; он все равно должен быть прос% тым и интуитивно понятным.

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

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

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

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

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

Что же это такое, конкретно?