Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 2.32 KB

File metadata and controls

91 lines (65 loc) · 2.32 KB

cTODO.md — TODO.md 작성 요령

TODO.md는 재현 가이드다. 이 프로젝트를 처음 접하는 사람이 읽고 그대로 따라하면 동일한 결과를 얻을 수 있어야 한다.


작성 원칙

  1. 성공한 경로만 담는다. 실패한 시도, 우회한 방법, 의미 없었던 작업은 제외.
  2. 명령어는 복사해서 바로 실행 가능하게 작성한다. 경로, 파일명, 옵션을 실제 값으로 기재.
  3. 체크리스트 형식(- [ ], - [x])으로 진행 상황을 추적할 수 있게 한다.
  4. 결과 검증 기준을 함께 적는다. 어떤 출력이 나와야 성공인지.
  5. 주의사항(⚠️) 은 해당 Step 바로 아래에 기재한다.

문서 구조

# [프로젝트명] 작업 TODO

> **목표**: 한 문장으로 최종 목적 기술
>
> **최종 결과물**: 실제로 사용하는 파일 경로
>
> **대상 파일**: 입력 파일 목록 (실제 확인된 경로 기준)

---

## Step N: [단계명]

- [x] **N-1.** 작업 설명
  ```bash
  실행 명령어  # 실제 경로/값 사용
  # → 예상 출력 또는 결과 파일

⚠️ 주의사항 (있을 경우)

  • N-2. 다음 작업 (미완료)

---

## 섹션 구성 예시

| 섹션 | 내용 |
|------|------|
| 헤더 | 목표, 최종 결과물, 입력 파일 |
| Step 1 | 환경 구성 (설치, 설정) |
| Step 2 | 입력 데이터 분석/검증 |
| Step 3~N | 핵심 변환/처리 작업 |
| Step N+1 | 검증 및 확인 |
| 마지막 섹션 | 필요 파일 요약, 반복 작업 절차 |

---

## 체크리스트 표기 규칙

- `- [x]` : 완료
- `- [ ]` : 미완료 (파일 수신 대기 등)
- `- ~~[ ]~~` : 건너뜀 (이유 명시)
- `> ⚠️` : 함정/주의사항

---

## 자주 쓰는 표 양식

**분석 결과 표**:
```markdown
| 항목 | 값 | 요구사항 | 비고 |
|------|----|---------|------|
| upAxis | Y | Z | 변환 필요 |

파일 요약 표:

| 파일 | 역할 | 크기 |
|------|------|------|
| `foo.usda` | 루트 레이어 | 1 KB |

반복 작업 섹션

동일한 절차를 다른 입력에 반복할 경우, 마지막에 "ERTI 2, 3 처리 절차" 같은 섹션을 추가한다:

# 파일명과 인덱스만 바꿔서 Step 3~5 반복
python3 gs_to_ply.py "입력2.usd" "output/ETRI2/출력2.ply"