본문 바로가기

IT 관련 지식/소프트웨어공학

좋은 기능 명세를 작성하기 위한 꿀 TIP!

반응형

안녕하세요 시란입니다. 

저번시간에는 명세서가 무엇인지에 대해서 포스팅 했었어요 

이번 시간에는 좋은 기능 명세를 작성하기 위한 꿀팁을 한번 알아보도록 하겠습니다. 

표준 명세서가 있다면 이를 따라하는것보다는 자신의 상황에 맞게 작성하는것이 중요합니다.

 

그리고 명세서를 읽는 사람이 편하게 읽을수 있도록 작성하는것이 중요합니다. 

만약 명세서가 유쾌하고 읽기 쉽다고 해서 당신을 얕보는 회사가 있다면 다른 회사를 가는것을 추천드린다고 합니다...

 

또한 명세 쓰는 작업은 머리가 돌아가도록 코드를 쓰는 작업과 유사합니다. 

무슨말이냐면 문서를 소개하려는 대상을 감안하고 그 사람이 무엇을 이해하길 바라는지 먼저 생각하는것이 중요합니다. 즉 독자층을 배려해야 합니다. 그래야 비 전공자가 읽어도 의사소통이 가능할 것입니다. 

 

최대한 단순하게 작성하는것이 핵심입니다. 

쉬운 문장으로 작성하면 왠지 아마추어 같다는 생각이 들수도 있습니다. 하지만 가장 쉬운 언어를 사용해야 효과적입니다. 왜냐하면 실제 화면보다 명세서(문서)를 잘 쓰기는 불가능하기때문이에요. 

또한 명세서는 지속적으로 개정해야 합니다. 

주기적으로 개정을 통해 현실을 최대한 반영해야 합니다. 명세는 항상 제품이 동작하는 원리를 반영해야만 하기 때문입니다. 

 

막 엄청 어렵지는 않지요? 간단하죠?

필자는 한번 지금까지 알아본 내용을 토대로 기술명세서를 작성해보려고 합니다. 

물론 시스템이 크면 클수록 힘들어 질 것이지만 일단 명세서를 작성해야 다음 커뮤니케이션을 할 수 있을 것입니다. 

 

그럼 다음 포스팅에서도 좋은 내용을 가지고 오겠습니다. 

감사합니다. 

 

 

 

반응형