Документ технической спецификации - это документ, содержащий правила и требования, которым должен соответствовать продукт или производственный процесс. Продукты или производственные процессы, которые не соответствуют требованиям и правилам, перечисленным в документе, не соответствуют спецификациям и обычно считаются не соответствующими спецификациям. Технические спецификации используются при заключении контрактов на производство или техническое обслуживание для определения правил выполнения контрактов.
Воспользуйтесь следующими советами, чтобы написать документ с технической спецификацией.
Шаг
Метод 1 из 3: общие соображения
Шаг 1. Решите, хотите ли вы написать открытую или закрытую спецификацию
- Рассмотрите возможность написания открытой спецификации. В открытом документе спецификации описываются только характеристики, которые должны быть достигнуты, без объяснения того, как этого добиться. Таким образом, разработчики могут прилагать любые усилия для соответствия спецификациям. Например, если вы пишете спецификацию памяти компьютера, вам не нужно указывать конкретный тип памяти, который следует использовать.
- Подумайте о написании закрытой спецификации. В дополнение к описанию характеристик, которые должны быть достигнуты, закрытый документ со спецификациями также описывает оборудование, технологию и методы сборки, которые должны использоваться при проектировании продукта или производственных процессах. Например, документ со спецификацией сборки машины может требовать, чтобы оператор использовал двигатель с гидравлическим приводом.
Шаг 2. Определите требования, оценив существующие спецификации
Шаг 3. Определите свой стиль письма
- Используйте короткие прямые предложения.
- Избегайте использования относительных местоимений. Четко изложите в тексте, что вы имеете в виду.
- Объясните технические термины и сокращения, обычно используемые в этой области. Чтобы объяснить технические термины, добавьте главу «Определения» в начало документа.
Шаг 4. Создайте оглавление
Поместите общие требования к продукту или производственному процессу в начале документа, а затем следуйте более конкретным разделам.
Метод 2 из 3: Создание спецификаций
Шаг 1. Запишите все потребности, которые должен удовлетворить продукт или производственный процесс
Используйте слово «должен», чтобы описать потребность. Потребности, описанные словом «должны», должны быть полностью выполнены исполнителем. Примите во внимание следующие факторы, чтобы определить необходимость, и при необходимости добавьте другие факторы:
- Определите подходящий вес и / или размер продукта.
- Полностью опишите условия окружающей среды, подходящие для эксплуатации продукта. Если характеристики продукта ухудшаются из-за чрезмерной влажности или температуры, укажите это в технических характеристиках.
- Дайте толерантность к производительности продукта или производственного процесса.
- Определите сторонние стандарты качества или безопасности, которые должны применяться к продукту или производственному процессу. Например, вы можете потребовать, чтобы ваш продукт прошел сертификацию UL или CSA.
- Опишите конкретные технические характеристики, которым должен соответствовать продукт или производственный процесс. Например, в спецификации электронного производственного процесса вы можете указать требования к интерфейсу и скорость производства, а для спецификации механического производственного процесса вы можете указать стандарт плотности или мощности.
- Определите срок службы продукта или производственного процесса. Если продукт или производственный процесс требует периодического обслуживания, включите подробное описание процесса в спецификацию. В спецификации вы должны указать условия, при которых требуется техническое обслуживание, и как часто его следует выполнять.
Метод 3 из 3: завершение спецификации
Шаг 1. Создайте заголовок и контрольный номер для спецификации
Также убедитесь, что вы создали документ спецификации, который можно редактировать.
Шаг 2. Определите орган, который может выпускать и изменять спецификации, и включите поле подписи в качестве подтверждения
Шаг 3. Внимательно прочтите спецификации
Представьте себя неопытным исполнителем или исполнителем, стремящимся сэкономить деньги за счет обхода спецификаций везде, где это возможно. После этого скорректируйте спецификации по мере необходимости, чтобы помочь начинающим разработчикам и закрыть лазейки хитрости.
