xxx 작업(권장: 동사 + 명사 형식)
참고:
1. 이 템플릿은 작업 가이드 문서의 권장 프레임워크를 제공합니다. 2. 기울임꼴 문장은 작성 지침이므로 최종 문서에서 삭제하세요.
【전체 작성 요구 사항】
1. 대상 독자 확인: 개발자, 제품 관리자 또는 아키텍트 등 대상 독자를 명확히 지정합니다.
2. 포함할 내용 확인: 기능/모듈이 무엇인지, 무엇을 할 수 있는지, 어떻게 조작하는지를 소개합니다.
3. 사용자 관점 채택: 개발자가 실제로 필요로 하는 내용을 개발자의 관점에서 제공합니다.
4. 작업 중심 작성: 개발자가 완료해야 하는 작업과 실제 절차에 집중합니다.
5. 유연한 적용: 실제 요구에 맞게 템플릿을 조정합니다.
개요
필수입니다.
개발자가 기능/모듈을 처음 이해할 수 있도록 무엇이며 왜 필요한지 정의합니다.
사전 요구 사항
필수입니다. 이 가이드의 단계를 실행하기 전에 사용자가 준비할 모든 항목을 정리합니다.
사전 요구 개념
선택 사항입니다. 사용 전에 이해해야 하는 개념을 나열하고 복잡한 관계에는 다이어그램을 사용합니다.
구현 원리
선택 사항입니다. 기능/모듈이 동작하는 방식을 설명합니다. 흐름도나 아키텍처 다이어그램을 사용하되 기밀 정보는 공개하지 않습니다.
사용 제한
선택 사항입니다. 지원하지 않는 시나리오와 사양 제한을 포함하여 개발에 영향을 주는 제한을 설명합니다.
- 이 기능은 XXX 버전 이상에서 지원됩니다.
- 각 객체의 크기는 100 KB를 초과할 수 없습니다.
환경 준비
선택 사항입니다. 하드웨어, 소프트웨어 및 운영 체제 요구 사항을 명확히 작성합니다.
작업 과정
선택 사항입니다. 시나리오 → 작업 로직 → 단계별 작업의 계층으로 구성합니다. 단계가 많으면 흐름도를 추가합니다.
작업 단계
【작성 요구 사항】
- 각 단계에 실행자, 목적, 작업 및 컨텍스트를 포함하고 명령형으로 작성합니다.
- 샘플 코드는 실행 가능해야 합니다.
- 완료 후 성공 여부를 확인하는 방법을 제공합니다.
- 전화번호, ID, 계정명, 실제 IP 및 도메인과 같은 민감한 정보는 마스킹하거나 예시 값으로 바꿉니다.
FAQ
선택 사항입니다. 작업 중 발생할 수 있는 일반적인 문제와 해결 방법을 작성합니다. FAQ 템플릿을 참고하세요.
다음 단계
개발자가 다음으로 탐색할 주제를 5개 이하의 목록으로 제안합니다.