자료 구조와 API 설계 문서의 제공, 갱신 시기

화면, 자료 변경의 영향 범위

화면과 자료 구조 모두 변경 비용이 발생합니다. 영향 범위와 사용 중인 자료, 연결된 기능에 따라 작업량이 달라집니다.

자료 구조를 변경하면 변환과 기존 기능의 수정, 호환성과 이전 자료의 대조가 필요할 수 있습니다. 모든 변경이 전체 자료 이전을 요구하는 것은 아닙니다.

중요한 자료와 처리 조건은 구현 전에 검토하고, 이후 변경도 기록합니다. 초기 설계를 고정하기보다 실제 요구에 맞추어 검증, 갱신합니다.

현재 정보와 거래 당시 기록의 구분

같은 정보가 여러 곳에 저장된다면 각각의 목적과 갱신 기준을 확인합니다.

회원의 현재 전화번호와 예약 당시의 연락처는 목적이 다를 수 있습니다. 현재 값으로 갱신할 정보와 당시 기록으로 보존할 정보를 구분합니다.

목적과 갱신 기준이 없으면 서로 다른 값을 잘못 사용할 수 있습니다. 자료의 원본과 변경, 대조 방법을 정합니다.

정보 변경 시 영향을 받는 화면과 업무를 설명받습니다. 저장 위치의 개수보다 일관성과 필요한 이력 보존이 중요한 기준입니다.

운영 통계와 필요한 기록

운영 통계에 필요한 자료는 측정 목적과 관리 조건을 함께 검토합니다.

취소 단계와 유입 정보 등 필요한 항목이 기록되지 않았다면 과거 값을 정확히 집계하기 어려울 수 있습니다. 기존 자료에서 확인 가능한 범위를 구분합니다.

필요한 통계와 집계 기준을 먼저 정하고 최소한의 기록을 설계합니다. 수집 목적과 보관, 접근 조건, 구현과 운영 비용도 확인합니다.

업무 예시를 통한 설계 확인

기술 문서가 익숙하지 않다면 업무 예시를 기준으로 설명받고 담당자와 함께 확인합니다.

예약이나 주문이 발생했을 때 저장, 조회, 변경되는 자료를 설명받습니다. 실제 업무와의 차이를 확인하고 기술 검증이 필요한 부분은 전문 검토로 보완합니다.

설계 문서의 제공과 갱신

필요한 설계, 운영 문서는 결과물 목록과 제공 범위에 포함합니다.

문서는 담당자 변경과 후속 수정, 운영 인계의 자료가 됩니다. 내용이 정확한지, 실제 구현과 일치하는지 함께 확인합니다.

기능, 위험에 맞는 문서 범위

문서 범위는 사업 규모뿐 아니라 기능과 위험, 운영 조건으로 정합니다.

1. 서버가 없는 소개 페이지데이터베이스와 서버 API 설계가 적용되지 않을 수 있음, 외부 문의와 분석 도구의 연결과 자료 관리 조건
2. 자료를 저장하는 서비스항목과 관계, 권한과 변경 기준
3. 결제, 정산, 자동 작업해당 규칙과 실패 처리, 운영 기록

업체에 필요한 문서와 생략 가능한 항목, 다른 자료로 대체할 수 있는 근거를 요청합니다. 실제 위험을 확인할 수 있는 수준인지 검토합니다.

프로토타입과 단계적인 설계 검토

프로토타입으로 화면과 업무를 확인하면서 설계를 구체화하는 방법도 가능합니다.

사용자가 실제 화면을 확인하면 설명만으로 파악하기 어려운 요구를 보완할 수 있습니다. 확인한 결정과 변경 내용은 기록합니다.

별도 문서의 형식보다 핵심 자료와 권한, 업무 규칙을 언제 검토하는지가 중요합니다. 시험용 구현과 운영용 구현의 조건도 구분합니다.

초기 설계와 시험의 범위, 실제 자료를 반영할 시점과 전환 조건을 합의합니다. 보완할 설계와 미정 사항의 담당자를 정합니다.

기관, 기업의 설계 검토와 제출

기관, 기업의 사업은 계약과 과업에서 정한 제출 문서, 검토와 승인 절차를 확인합니다.

설계 중 검토본과 실제 구현을 반영한 최종본은 목적이 다릅니다. 최종 문서만으로 개발 중의 결정과 위험 검토가 이루어졌는지 알 수는 없습니다.

1. 검토본관련 구현 전중요한 설계의 검토
2. 보완본개발과 시험 중보완
3. 최종본인계 시실제 상태와 대조

항목별 시점을 일정에 반영합니다.

업무 담당자와 기술 담당자의 검토 범위를 나누어 확인합니다. 권한과 상태가 업무에 맞는지, 자료와 연동의 기술 조건을 함께 점검합니다.