설계 문서 리뷰 가이드

on under algorithm
1 minute read

구글은 소프트웨어를 어떻게 테스트하는가

설계 문서 리뷰 가이드

완전성(Completeness)

문서의 불완전한 부분, 일반적으로 사용하기 어렵거나 특별한 지식을 요구하는 부분, 새로운 맴버가 알아야 하는 부분을 식별해야 한다. 상세히 적도록 하고, 부족한 부분은 다른 문서와 링크한다.

정확성(Correctness)

문법, 철자, 마침표에 대한 실수를 찾는다.

일관성(Consistency)

문서와 다이어그램을 일치하게 한다. 문서 간의 상충되는 내용이 없게해야 한다.

설계(Design)

-현재 가용할 수 있는 자원으로 끝낼 수 있는가? -어떤 인프라스트럭처 위에서 가능한가?(인프라스트럭처의 문서를 읽고 위험성을 파악해야한다.) -제안된 설계를 지원할 수 있는 인프라스트럭처가 사용 가능한가? -설계가 너무 복잡하지 않는가? -단순화 시킬 수 있는가? -너무 단순한가? -설계의 어떤 부분의 설명이 부족한가?

인터페이스(Interfaces)와 프로토콜(Protocols)

-사용할 프로토콜에 대해 명확하게 식별돼 있는가? -제품에서 드러나는 인터페이스와 프로토콜이 완벽하게 설명돼 있는가? -이러한 인터페이스와 프로토콜을 완성하기 위해 의미있는 작업이 수행되는가? -다른 제품에 공통적으로 적용하는 내용이 있는가? -개발자가 프로토콜 버퍼를 정의하게 할 수 있는가?

테스팅(Testing)

-문서에 기술된 시스템들을 어떻게 테스트하는가? -새로운 테스트 장비나 기술이 필요하다면 문서에 추가한다. -시스템에 대한 설계 내용이 테스트를 더 쉽게 해주고, 기존 테스트 인프라스트럭처를 사용할 수 있게 하는가? -시스템을 테스트하기 위해 선행돼야 할 내용고 개발자가 설계문서에 추가해야 하는 정보들을 미리 추정한다.


출처: 구글은 소프트웨어를 어떻게 테스트하는가

algorithm
comments powered by Disqus