Шаблоны технических и функциональных спецификаций [закрыто]

Question

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

Что ты используешь?Насколько глубоко вы погружаетесь в написание спецификаций?Будем признательны за любые дополнительные общие советы, которые вы могли бы предоставить.

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

РЕДАКТИРОВАТЬ: Я прочитал мнение Джоэла о Безболезненная спецификация, мне очень понравилось, но есть ли еще мнения :)

Answer 1

Об общих советах;

Мы реализуем процесс

1) Заявление о бизнес-требованиях (BRS)

2) Функциональная спецификация

3) Техническая спецификация

BRS охватывает проблемы бизнеса и требования к решениям, тестированию, безопасности, надежности и доставке.Это определяет, что будет способствовать успешному решению.

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

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

Заказчик владеет требованиями.Разработчики владеют техническими спецификациями, а функциональная спецификация — это золотая середина.Тестирование проводится по техническим спецификациям (обычно модульное тестирование), затем по функциональным спецификациям (обычно тестирование системы), а затем по требованиям (UAT).

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

Короче говоря, мой главный совет — сначала продумайте процесс, который вы хотите реализовать.Затем добейтесь согласия всех сторон, участвующих в предлагаемом вами процессе, а затем поработайте над подходящими шаблонами.Сами шаблоны — это лишь малая часть изменений, которые вы хотите внести.

Answer 2

Это не шаблон, но Джоэл написал пара статей по написанию функционального спецификации.У него также есть образец здесь.

Answer 3

Вы можете купить шаблоны на ieee и других местах, но я всегда делал свои собственные.

По техническим характеристикам"Код завершен» Стива Макдоннелла есть хороший контрольный список, из которого вы можете почерпнуть некоторую информацию.На своей последней работе я просто сделал шаблон из заголовков его разделов и настроил его оттуда.

Что касается функциональной спецификации, важно определить все интерфейсы:

1. Пользовательский интерфейс (макеты экрана)
2. Программные интерфейсы (плагины и т. д.)
3. Аппаратные интерфейсы (если применимо)
4. Коммуникационные интерфейсы (сервисы, электронная почта, обмен сообщениями и т. д.)

Также должен быть раздел для бизнес-правил, вещей, которые важны с функциональной точки зрения и не описаны ни в одном определении интерфейса.

Answer 4

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

Answer 5

Мне, среди прочего, нравится вот это: Готовый набор.

Он продает и про версию.

Answer 6

Это лучшее, что я нашел: http://www.jiludwig.com/templates/FRDTemplate.doc

Answer 7

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

Answer 8

Я бы посоветовал взглянуть на шаблон Volere Роберстона. здесь.Они являются частью Гильдии атлантических систем вместе с такими людьми, как Том ДеМарко и Тимоти Листер, известные как «Peopleware».

Поскольку шаблон защищен авторским правом, я не буду воспроизводить его здесь, но приведу некоторые основные заголовки:

1. Цель проекта
2. Заинтересованные стороны
3. Обязательные ограничения
4. Соглашения об именах и терминология
5. Соответствующие факты и предположения
6. Объем работы
7. Модель бизнес-данных и словарь данных
8. Область применения продукта
9. Функциональные требования
10. Посмотрите и чувствуете требования ...

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

Смотреть здесь в главе 9.