문서 설계 노트

이 페이지는 LogBird 프로젝트 문서를 설계하며 고려한 전략과 기술적 판단 근거를 기록한 케이스 스터디입니다.

1. 페르소나 및 독자 정의

타겟: 터미널 환경이 낯선 신입 개발자 및 QA 엔지니어.
니즈: 복잡한 이론보다는 “지금 당장 내 눈앞의 로그를 어떻게 보는가”에 대한 해답 필요.
설계 반영: 추상적인 기능 설명보다 복사 가능한 명령어 예시(Quick Start)를 최상단에 배치.

2. 정보 구조(Information Architecture) 설계

독자의 탐색 흐름에 따라 정보를 3단계로 계층화했습니다.

가이드(Guides): 특정 목적(Task)을 달성하기 위한 단계별 안내.
참조(Reference): 숙련자를 위한 명령어 사전 및 옵션 상세 표.
설계 노트(Design Notes): 문서의 신뢰성을 높이기 위한 메타 데이터.

3. 라이팅 스타일 가이드

일관된 용어: ‘모니터링’, ‘감시’, ‘체크’를 ‘감시(watch)’라는 핵심 용어로 통일하여 인지 혼란 방지.
명확한 행동 유도: “사용할 수 있습니다”와 같은 추측형 대신 “입력하세요”, “확인하세요” 등 능동형 명령문 사용.
시각적 강조: 코드 블록과 인용구(>)를 활용하여 주의사항과 팁을 시각적으로 분리.

4. 향후 개선 계획

이미지 추가: CLI 실행 결과 스크린샷을 추가하여 독자의 심리적 장벽 완화.
검색 최적화: 자주 묻는 질문(FAQ) 섹션을 추가하여 검색 유입 대응.