사양을 작성하려면 어떤 문법 시제를 사용해야합니까?


21

현재 기능 및 기술 사양을 2 열 형식으로 작성하고 있습니다. 요약 문장 및 기술적 세부 사항. 세부 사항은 종종 다이어그램이있는 부록, 레이아웃 디자인을 나타냅니다.

그러나 나는 그것을 작성하는 시제로 고심하고 있습니다.

마치 일이 끝난 것처럼 과거 시제로 나는 일을 끝내는 일의 하이라이트 확장을 보여주기 위해 고군분투한다 X 가해 야 할 미래 시제는 X가 할 일 목록처럼 들리기 시작하거나 시제 중립이 끝나거나 완료 될 때 매우 어려워지기 시작합니다.

혼란을 더하기 위해 영어를 모국어로 사용하지 않는 사람들이이 사양을 읽을 수 있습니다.

답변:


12

우리는 마지막 직장에서 많은 것을 얻었습니다.

제품 관리자는 다음과 같이 현재 시제를 사용하여 수행해야 할 작업 을 설명 합니다 .

사용자가 주문을 보냅니다. 시스템이 확인 메시지를 보냅니다.

불행히도 전제 조건에 대한 설명은 다음과 같이 현재 시제에서 수행되었습니다.

사용자는 품목을 장바구니에 넣고 수량을 지정합니다.

이미 무엇이 있는지, 아직 오지 않을 것이 확실하지 않기 때문에 이것은 많은 혼란을 초래했습니다. 나는 그들이 미래 시제를 사용하도록 노력했지만 결코 바뀌지 않았습니다. 개인적으로, 나는 2 년 동안 그곳에 익숙해지지 못했습니다. 누군가가 언어 시제에 능숙하지 않은 것처럼 들리는 것은 말이되지 않습니다.


따라서:

  • 이미 존재하는 것에 대해 현재 시제 사용

  • 해야 할 일에 대해 미래 시제를 사용하십시오. 세계를 "해야한다", "해야한다", "의지"를 사용하십시오.


기억해야 할 중요한 단계는 사양을 다시 보는 것입니다. 미래에 현재까지 표현을 업데이트하십시오.
벤 L

@ BenL : 아니, 그건 틀렸어. 시제는 구현 상태를 나타내지 않고 올바른 구현을 제공하는 방법에 사용됩니다. 여기서 미래 시제는 미래의 구현 상태가 아니라 미래의 애플리케이션 상태를 나타내는 데 사용됩니다. 제쳐두고, 여기에 옹호 된 접근 방식은 대부분의 RFC에서도 사용된다는 점에 주목할 가치가 있습니다. 필수 / 필수 / 할당 (불필요), 권장 / 추천 (불가능) 및 가능 / 선택적 용어에 대해서는 RFC 2119 를 참조하십시오 .
브라이언

5

현재 시제가 나에게 좋을 것 같습니다.

  1. 전제 조건 : Foo는 X 상태
  2. 작업 : 이것과 그 일이
  3. 사후 조건 : Foo는 상태 Y에 있습니다.

그것들은 모두 현재 시제에 있습니다.

또는 "프로젝트 상태"인 경우

  1. 버전 10 : 기능 A, B, C 및 D

  2. 버전 10.1 : A에 대한 개선 사항이 포함되어 있습니다. B의 버그 1049를 수정합니다. 새로운 기능 E를 추가합니다.




1

소프트웨어 디자인을 만들 때 소프트웨어가 존재하기 전에 디자인을 만들더라도 현재 시제를 선호합니다. 디자인에서 소프트웨어 응용 프로그램을 구현 한 후에도 디자인은 여전히 ​​중요하고 중요한 문서입니다. 설계 문서는 소프트웨어가 구현 된 후보다 구현 된 후보다 오랜 기간 동안 관련성이있을 수 있습니다.

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.