Когда я работал в крупной компании с CMMI3 приучили когда пишешь спецификации использовать shall в понимании "обязательно к исполнению", should в случае рекомендаций. шаг влево, шаг вправо — низзя...
В другой компании не старающей таким количеством заморочек (как выяснилось к сожалению не страдающей) все пишут как попало... мало того и отстаивают свою точку зрения аж до уровня чуть ли не топменеджмент...
Короче за последние полтора года рекомендации по использованию несколько раз менялись...
Короче говоря предлагаю перейти к примерам...
Итак, фраза на русском должна была бы звучать так:
Модуль должен брать на вход файл abc.txt.
Я перевел это как
The module shall take abc.txt file as input.
Начальник сказал, что это неправильно, т.к. должно быть так:
The module will take abc.txt file as input.
На мой взгляд может быть это и не лишено смысла для заказчиков для которых это звучит как "Модуль будет брать на вход...". Т.е. они либо соглашаются, что таки будет, либо не соглашаются и стучат нам по голове.
Для локального девелопера это смысл как раз не имеет — что значит будет? а может для программинга это не удобно и собственно девелопер решит сделать по другому — нигде же не запрещается
В процессе споров подключился еще народ: одна знают как надо писать спецификации, другие знают английский, третьи просто потрендеть...
В список добавилист слова:
must — прямое целеуказание как нужно сделать
have to — такое же прямое, но более "политкорректное"
should — все таки рекомендация
Здравствуйте, Graf Alex, Вы писали:
GA> <...
//много поскипал, т.к. не понятно, что же является в этом сообщении точным вопросом, а что приведено для иллюстрации GA> ...>
GA>Как же собственно правильно?
Предлагаю для начала простой ответ: правильно будет так, как вы сами укажете в спецификации, в разделе "используемые термины". Устроит ?
Все, что здесь сказано, может и будет использоваться против меня.
Re[2]: shall/should/will/have to/must как правильно?
Здравствуйте, Константин Л., Вы писали:
КЛ>The module takes — берет, это факт.
Ну ключевое слово "должен", а не "берет"
Я просто долго думал над фразой, так что бы не придолбались к другим словам... не вышло
Парочка других примеров из спецификаций (их русский оригинал):
— Директория должна именоваться по таким то правилам...
— Модуль должен состоять из таких подмодулей...
— Алгоритм работы должен быть такой...
— при нахождении ошибки в лог должно быть записано такое то сообщение...
Could do something -> It's possible for someone to do something.
Must do something -> It's absolutely necessary for someone to do something.
Need to do something -> It's important to do something.
Have to do something -> It's absolutely necessary for someone to do something and someone else requires it.
если мне не изменяет память, то shall это просто форма от will, и в данном случае начальник прав, shall там просто не смотрится.
далее, в HLA (high level architecture) нормально писать в будущем времени:
This module will take some input parameters and (will) produce some output described elsewhere.
потому как на момент написания HLA ни модуля ни интерфейса пока еще не существует.
в технической спеке мы пишем в настоящем времени: интерфейс модуля к тому времени уже утвержден и о нем стоит говорить в present tense или present continuous:
this module takes the following parameters:
a — alpha
b — beta
не возвбраняется писать the module is taking the following parameters...
Re[2]: shall/should/will/have to/must как правильно?
Здравствуйте, Alex Reyst, Вы писали:
AR>Предлагаю для начала простой ответ: правильно будет так, как вы сами укажете в спецификации, в разделе "используемые термины". Устроит ?
включать в раздел используемых терминов секцию об английской грамматике это, несомненно, отличная идея
Re[3]: shall/should/will/have to/must как правильно?
Здравствуйте, Graf Alex, Вы писали:
GA>Здравствуйте, Константин Л., Вы писали:
КЛ>>The module takes — берет, это факт. GA>Ну ключевое слово "должен", а не "берет"
я о том, что можно "зафиксировать" требование настоящим временем, о чем, собсно, ниже пишет B0rG
[]
Re[3]: shall/should/will/have to/must как правильно?
Здравствуйте, B0rG, Вы писали:
BG>Здравствуйте, Alex Reyst, Вы писали:
AR>>Предлагаю для начала простой ответ: правильно будет так, как вы сами укажете в спецификации, в разделе "используемые термины". Устроит ?
Да
иногда оно как раз самое оно... иногда правда нет BG>включать в раздел используемых терминов секцию об английской грамматике это, несомненно, отличная идея
В упомянутой мною фирме с CMMI3 был специальный документ, который регламентировал написание других документов... В частности спецификаций и использования в них слов shall и should
В каждый документ это конечно же пихать не нужно... только ссылку
Re[4]: shall/should/will/have to/must как правильно?
Здравствуйте, Graf Alex, Вы писали:
BG>>включать в раздел используемых терминов секцию об английской грамматике это, несомненно, отличная идея GA>В упомянутой мною фирме с CMMI3 был специальный документ, который регламентировал написание других документов... В частности спецификаций и использования в них слов shall и should GA>В каждый документ это конечно же пихать не нужно... только ссылку
это хде такое? в россии? че за контора? cmmi с iso9000 каким-нибудь?
на мой взгляд, знания английского и здравого смысла автора документа вполне хватает.
Re[3]: shall/should/will/have to/must как правильно?
Здравствуйте, B0rG, Вы писали:
BG>далее, в HLA (high level architecture) нормально писать в будущем времени: BG>This module will take some input parameters and (will) produce some output described elsewhere. BG>потому как на момент написания HLA ни модуля ни интерфейса пока еще не существует.
BG>в технической спеке мы пишем в настоящем времени: интерфейс модуля к тому времени уже утвержден и о нем стоит говорить в present tense или present continuous:
Ну с HLA и техспеками по готовым модулям все понятно...
а если мы только планируем писать модуль?
Т.е. известно только на высоком уровне как оно будет, но никаких деталей еще нет
Re[3]: shall/should/will/have to/must как правильно?
Здравствуйте, Graf Alex, Вы писали:
BG>>в технической спеке мы пишем в настоящем времени: интерфейс модуля к тому времени уже утвержден и о нем стоит говорить в present tense или present continuous: GA>Ну с HLA и техспеками по готовым модулям все понятно... GA>а если мы только планируем писать модуль? GA>Т.е. известно только на высоком уровне как оно будет, но никаких деталей еще нет
На мой взгляд, та же система:
В секции HLA (как правило в начале документа) можно говорить о модуле в будущем времени, а в его детальном описании парой страниц позже уже в настоящем, ведь само по себе детальное описание подразумеват существование сущности в настоящем.
Хотя надо глянуть на ссылки от Рейста на manual of style, должно быть интересно.
Примерно так:
HLA:
The module will be written to assist in certain procedures.
Detailed Interface spec:
The module takes the parameter a as a main processing point bla-bla — параметр существенный
The module may take log path parameter — aLogPath опциональный параметер.
The module needs (is relying on) certain data being present at the database (or wherever?)
Re[4]: shall/should/will/have to/must как правильно?
Здравствуйте, Alex Reyst, Вы писали:
AR>Здравствуйте, B0rG, Вы писали:
BG>>включать в раздел используемых терминов секцию об английской грамматике это, несомненно, отличная идея
AR>Да. Жаль, что она пришла мне в голову не первому — много раньше до этого додумались другие (RFC-2119, IEEE Standards Style Manual и др.)
надо бы глянуть..
но с другой стороны IEEE все таки торгует своими стандартами, и для них это практически основной продукт, там наличие manual of style обусловлено его коммерческой сущностью.
Re[2]: shall/should/will/have to/must как правильно?
BG>Could do something -> It's possible for someone to do something.
BG>Must do something -> It's absolutely necessary for someone to do something.
BG>Need to do something -> It's important to do something.
BG>Have to do something -> It's absolutely necessary for someone to do something and someone else requires it.
BG>если мне не изменяет память, то shall это просто форма от will, и в данном случае начальник прав, shall там просто не смотрится.
In many requirement specifications (particularly in software), the words shall and will have special meanings. Most requirement specifications use the word shall to denote a requirement. The word will is reserved for a statement of fact. However, some documents deviate from this convention and use the words shall, will, and should to denote the strength of the requirement. Well-written requirement specifications define these words near the beginning of the document.
For example, on standards published by IEC (International Electrotechnical Commission), ASTM (American Society for Testing and Materials), IEEE (Institute of Electrical and Electronics Engineers), requirements with "shall" are the mandatory requirements, meaning, "must", or "have to". The IETF (Internet Engineering Task Force) defines shall and must as synonymous terms denoting absolute requirements, and ‘‘should’’ as denoting a somewhat flexible requirement, in RFC documents.[5]
In a specification, there are terms to be avoided and terms that must be used in a very specific manner.
Authors need to understand the use of shall, will, and should:
Requirements use shall.
Statements of fact use will.
Goals use should.
These are standard usage of these terms in government agencies and in industry. You will confuse everyone if you deviate from them.
Здравствуйте, Graf Alex, Вы писали:
GA>Короче говоря предлагаю перейти к примерам... GA>Итак, фраза на русском должна была бы звучать так: GA>Модуль должен брать на вход файл abc.txt.
GA>Я перевел это как GA>The module shall take abc.txt file as input.
GA>Начальник сказал, что это неправильно, т.к. должно быть так: GA>The module will take abc.txt file as input.
In many standards track documents several words are used to signify
the requirements in the specification. These words are often
capitalized. This document defines these words as they should be
interpreted in IETF documents. Authors who follow these guidelines
should incorporate this phrase near the beginning of their document:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
RFC 2119.
Note that the force of these words is modified by the requirement
level of the document in which they are used.
1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the
definition is an absolute requirement of the specification.
2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the
definition is an absolute prohibition of the specification.
3. SHOULD This word, or the adjective "RECOMMENDED", mean that there
may exist valid reasons in particular circumstances to ignore a
particular item, but the full implications must be understood and
carefully weighed before choosing a different course.
4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that
there may exist valid reasons in particular circumstances when the
particular behavior is acceptable or even useful, but the full
implications should be understood and the case carefully weighed
before implementing any behavior described with this label.
5. MAY This word, or the adjective "OPTIONAL", mean that an item is
truly optional. One vendor may choose to include the item because a
particular marketplace requires it or because the vendor feels that
it enhances the product while another vendor may omit the same item.
An implementation which does not include a particular option MUST be
prepared to interoperate with another implementation which does
include the option, though perhaps with reduced functionality. In the
same vein an implementation which does include a particular option
MUST be prepared to interoperate with another implementation which
does not include the option (except, of course, for the feature the
option provides.)
Re[3]: shall/should/will/have to/must как правильно?
Здравствуйте, Sergey Chadov, Вы писали:
BG>>если мне не изменяет память, то shall это просто форма от will, и в данном случае начальник прав, shall там просто не смотрится.
SC>
SC>In many requirement specifications (particularly in software), the words shall and will have special meanings. Most requirement specifications use the word shall to denote a requirement. The word will is reserved for a statement of fact. However, some documents deviate from this convention and use the words shall, will, and should to denote the strength of the requirement. Well-written requirement specifications define these words near the beginning of the document.
SC>For example, on standards published by IEC (International Electrotechnical Commission), ASTM (American Society for Testing and Materials), IEEE (Institute of Electrical and Electronics Engineers), requirements with "shall" are the mandatory requirements, meaning, "must", or "have to". The IETF (Internet Engineering Task Force) defines shall and must as synonymous terms denoting absolute requirements, and ‘‘should’’ as denoting a somewhat flexible requirement, in RFC documents.[5]
Источник всегда полезно указывать, т.к. без него это просто кусок английского текста.
Re[4]: shall/should/will/have to/must как правильно?