Научитесь разрабатывать спецификации требований к программному обеспечению (с советами)
Разработка программного обеспечения — это процесс выявления потребностей и разработки решений с помощью программного обеспечения. Однако после разработки программное обеспечение нуждается в вспомогательных описаниях и пояснениях, чтобы его могли понять клиенты или инвесторы. Знание того, как написать документ с требованиями, может помочь вам подтвердить ваше понимание потребностей клиентов и вашу способность предоставить их им. В этой статье мы определяем спецификацию требований к программному обеспечению, описываем, как разработать документ, и перечисляем советы, которые помогут вам успешно создать эти документы.
Что такое спецификации требований к программному обеспечению?
Спецификации требований к программному обеспечению (SRS) — это документы, описывающие функциональные возможности предлагаемого программного приложения. Они являются неотъемлемой частью процесса разработки программного обеспечения. Они могут существовать сами по себе, хотя часто существуют как часть серии документов, предназначенных для продажи идеи нового приложения клиенту или инвесторам. Некоторые предприятия и компании также называют их спецификациями системных требований или документами с требованиями к программному обеспечению.
Требования к программному обеспечению часто описывают текущую бизнес- или технологическую проблему, требующую решения, и описание того, как предлагаемое программное обеспечение решает эту проблему. Документы СГД могут включать:
Список текущих проблем, с которыми может столкнуться клиент
Описание того, как предлагаемое программное обеспечение может решить эти проблемы.
Подробное описание каждой отдельной функции программного обеспечения, например конкретное использование кнопок или требования к уведомлениям.
Описание операционных систем и технологических сред, в которых может работать программное обеспечение.
Диаграммы и диаграммы, показывающие, как использовать программное обеспечение для различных целей.
Возможные риски и решения для проекта
Как писать требования к спецификациям ПО
Хотя спецификации требований к программному обеспечению различаются от одного проекта к другому, есть некоторые общие шаги, которые вы можете предпринять при их написании. Если вы хотите научиться писать требования для собственного программного проекта, рассмотрите следующие шаги:
1. Определите своего предполагаемого клиента
Если вы намерены разрабатывать программное обеспечение, которое помогает решать проблемы или оптимизировать процессы, полезно понимать, кто ваш клиент и какое программное обеспечение ему может понадобиться. Как только вы узнаете, кто ваш клиент, вы сможете встретиться с ним, чтобы обсудить наиболее полезные для него функции программного обеспечения.
2. Выберите структуру вашего документа
Хотя ваш документ описывает функциональные возможности программного обеспечения, полезно, если сам документ также является функциональным. Сильная структура может прояснить информацию для ваших читателей и повысить читабельность. Общая структура начинается с самых широких тем и продолжается более конкретными темами. Например, примерная структура может быть:
Раздел первый: цели, проблемы и пожелания клиента
Раздел второй: предложение программного обеспечения для достижения этих целей и решения любых проблем
Раздел третий: подробное описание функциональных возможностей программного обеспечения
3. Ведите черновой документ
По мере того, как вы и ваша команда разрабатываете идеи для программного обеспечения, создавайте документ для каждой функции. Этот план может помочь вам следить за своими идеями. Когда вы определите, какие функции соответствуют вашим целям и как их лучше всего реализовать, отредактируйте документ, чтобы отразить текущий статус вашего проекта. При использовании этого метода, как только ваша команда решит, что пришло время написать требования к программному обеспечению, вы можете начать с первоначального описания каждой функции.
4. Напишите подробное описание вашего программного обеспечения
Используя черновой документ в качестве руководства, вы можете описать каждую функцию программного обеспечения и требования. При их написании полезно использовать как можно более точную формулировку. Также полезно описывать только одну функцию или требование за раз. Таким образом, ваш документ будет четким и понятным для ваших клиентов.
5. Проверьте свой документ
Поскольку спецификации требований к программному обеспечению должны точно описывать функции программного обеспечения, полезно ознакомиться с ними перед отправкой. Таким образом, вы сможете исправить любые ошибки и заменить расплывчатые слова более конкретными.
6. Создайте разделы предложения вашего документа
Хотя описание функций программного обеспечения является ключевым разделом вашего документа, оно часто существует как часть более крупного проектного предложения. Если вы работаете в команде, другие участники могут написать цели проекта, проблемы и решения. Если вы пишете их самостоятельно, часто полезно помнить, что эти разделы предложений помогают продать ваш проект вашему клиенту. Поскольку они обычно предшествуют требованиям к программному обеспечению, хорошо написанное предложение может помочь вашему клиенту прочесть ваши требования к программному обеспечению.
При написании разделов предложения полезно ссылаться на цели и потребности вашего клиента, чтобы вы могли лучше понять, как представить свои идеи в виде полезных для них решений.
Советы по написанию спецификаций требований к программному обеспечению
При написании требований к программному обеспечению полезно учитывать следующие советы:
Быть конкретной
Важно, чтобы описания функциональных возможностей вашего программного обеспечения были четкими и конкретными. Это не только помогает объяснить вашим клиентам, как ваше программное обеспечение может им помочь, но и помогает им понять, как использовать ваше программное обеспечение, когда оно у них есть.
Опишите одну функцию за раз
Сосредоточьтесь на кратких объяснениях, которые стремятся упростить и прояснить. Сохраняйте простые структуры предложений, чтобы сосредоточиться на каждой конкретной детали. Описывая только одну функцию за раз, вы можете помочь вашим инструкциям оставаться четкими, краткими и понятными.
Включите глоссарий терминов
Важно, чтобы все, кто читает ваш документ, понимали, что они читают. Если вы включаете какую-либо формулировку, относящуюся к вашему программному обеспечению, вашей должности разработчика или которую ваш клиент может неправильно понять, подумайте о том, чтобы включить глоссарий, определяющий каждый из этих терминов. Таким образом, ваш клиент сможет точно понять, что он читает.
Используйте активное время
Полезно убедиться, что вы используете активные описания своих функций. Это повышает читабельность вашего документа. Например, желтая кнопка нажата, чтобы выйти из программы, использует пассивный глагол нажат. Вместо этого сделайте пользователя программы активной частью описания, написав: Пользователь нажимает желтую кнопку, чтобы выйти из программы.
Применяйте последовательную формулировку
Чтобы ваши инструкции были четкими и конкретными, полезно убедиться, что повторяющиеся формулировки означают одно и то же каждый раз, когда вы их используете. Например, некоторые слова могут показывать приоритет или определенную функциональность. Таким образом, полезно использовать эти слова одинаково каждый раз. Например, во многих спецификациях требований к программному обеспечению эти глаголы используются для обозначения определенных функций:
Должен: это описывает, как требование к программному обеспечению работает каждый раз, когда пользователь выполняет это действие. Например, программное обеспечение должно анализировать данные из этих результатов.
Уилл: Это описывает фактическое утверждение. Например, отчет покажет эти результаты.
Должен: это описывает цель для программного обеспечения, когда ваша команда еще не определила функцию. Например, функция поиска должна найти данные из этих источников.
Какие профессии пишут спецификации требований к программному обеспечению?
Написание требований к программному обеспечению не относится к одной профессии или должности. Когда инженеры-программисты разрабатывают новое программное обеспечение, они обычно привлекают для написания документа кого-то, занимающего одну из следующих должностей:
Технический писатель
Технические писатели создают документы для объяснения сложного исходного материала. Это требует от них досконального понимания материала, чтобы они могли объяснить технические аспекты программного обеспечения или других технологий так, как это понятно большинству пользователей. Они часто пишут руководства пользователя для программного обеспечения, приборов и другого оборудования, а также документы, такие как спецификации требований к программному обеспечению.
Системный архитектор
Системные архитекторы проектируют и создают программные системы по спецификациям клиентов. Они досконально разбираются в технологиях, лежащих в основе их систем, и часто создают руководства пользователя и требования к программному обеспечению для создаваемых ими систем.
Программист
Программисты-программисты разрабатывают, проектируют и создают программное обеспечение для корпоративного и развлекательного использования. Поскольку они принимают активное участие в создании программного обеспечения, они часто понимают функциональность требований и сами пишут документ.