xxx 서브시스템/모듈 개발 가이드
참고:
1. 이 템플릿은 개발 가이드 문서의 작성 프레임워크를 제공합니다. 먼저 요구 사항과 시나리오를 분석한 후 이 템플릿을 사용하세요. 2. 기울임꼴 문장은 작성 지침이므로 최종 문서에서 삭제하세요.
【전체 작성 요구 사항】
1. 대상 독자 확인: 개발자, 제품 관리자 또는 아키텍트 등 대상 독자를 명확히 지정합니다.
2. 포함할 내용 확인: 기능/모듈이 무엇인지(What), 무엇을 할 수 있는지(Why), 어떻게 개발하는지(How)를 소개합니다.
3. 개발자 관점 채택: 개발에 필요한 관련 내용을 개발자의 관점에서 제공합니다.
4. 작업 중심 작성: 개발자가 수행해야 할 작업과 실제 절차에 집중합니다.
5. 유연한 적용: 이 템플릿은 참고용이므로 실제 요구에 맞게 조정합니다.
xxx 소개(구체적인 기능/모듈 이름)
필수입니다.
개발자가 기능/모듈을 처음 이해할 수 있도록 무엇이며 왜 필요한지 명확히 설명합니다.
【개발자 관점】 기능/모듈의 정의와 해결하는 문제 또는 제공하는 가치를 설명합니다.
【작성 팁】 익숙한 상황(Situation) → 현실과 기대의 불일치(Complication) → 질문(Question) → 해결책(Answer)의 SCQA 흐름을 사용합니다.
【작성 요구 사항】
- 필요한 용어, 약어 또는 고유 명사만 사용하고 설명이나 용어집 링크를 제공합니다.
기능
선택 사항입니다. 기능/모듈의 핵심 기능을 설명합니다.
장점
선택 사항입니다. 유사한 업계 기능과 비교한 장점을 과장 없이 설명합니다.
사전 요구 개념
선택 사항입니다. 이 기능/모듈을 사용하기 전에 이해해야 하는 개념을 나열하고, 복잡한 관계에는 다이어그램을 추가합니다.
구현 원리
선택 사항입니다. 기능/모듈의 동작 원리를 설명합니다. 필요한 경우 흐름도나 아키텍처 다이어그램을 사용하며 기밀 정보는 공개하지 않습니다.
사용 제한
선택 사항입니다. 개발에 영향을 주는 제한을 설명합니다.
- 지원하지 않는 사용 시나리오
- 사양 제한
- 이 기능은 XXX 버전 이상에서 사용할 수 있습니다.
- 각 객체의 크기는 100 KB를 초과할 수 없습니다.
관련 기능 모듈과의 관계
선택 사항입니다. 강한 의존성이나 연관성이 있는 기능/모듈을 설명합니다.
환경 준비
선택 사항입니다. 하드웨어, 소프트웨어 및 운영 체제 등 개발 환경 요구 사항을 명확히 설명합니다.
환경 설정
【작성 요구 사항】
개발 환경을 단계별로 설정하고 설정이 성공했는지 확인하는 방법을 포함합니다.
- SSH로 Linux 서버 터미널에 로그인합니다.
- 다음 명령으로 기본 패키지를 설치합니다.
xxxxx
- 다음 명령으로 설치 버전을 확인합니다.
xxxxx
개발 프로세스
기능/모듈을 사용하는 방법을 시나리오(작업) → 작업 로직(개발 흐름) → 단계별 절차의 계층으로 작성합니다. 단계가 많으면 흐름도를 제공합니다.
API 설명
선택 사항입니다. 개발 과정의 주요 API를 설명하고 가능한 경우 하이퍼링크를 제공합니다.
개발 단계
【작성 요구 사항】
- 각 단계에 실행자, 목적, 작업 및 컨텍스트를 포함하고 명령형으로 작성합니다.
- 샘플 코드는 실행 가능해야 합니다.
- 성공 여부를 확인하는 방법을 제공합니다.
- 전화번호, ID, 계정명 등 민감한 정보는 마스킹하고 실제 IP나 도메인은 사용하지 않습니다.
자체 테스트
선택 사항입니다. 환경 설정, 테스트 단계, 예상 결과 및 일반적인 문제와 해결 방법을 작성합니다.
관련 예제
선택 사항입니다. 추가 학습을 위한 샘플 코드나 데모 링크를 제공합니다.
디버깅 및 진단 도구
선택 사항입니다. 개발, 테스트 또는 실행 중 문제를 빠르게 찾고 해결하는 도구와 링크를 소개합니다.
FAQ
선택 사항입니다. 개발 중 자주 발생하는 문제와 해결 방법을 작성합니다. FAQ 템플릿을 참고하세요.
다음 단계
개발자가 다음으로 살펴볼 주제를 5개 이하의 목록으로 제안합니다.