update-faq

name	update-faq
description	FAQ 추가 및 수정 시 문체의 일관성을 유지하고, 프론트/백엔드 데이터 동기화를 보장하는 패턴 가이드

FAQ 업데이트 가이드 (update-faq)

이 스킬은 "자주 하는 질문(FAQ)에 ~를 추가해 줘", "FAQ 내용을 바꿔줘"와 같은 요청을 수행할 때 반드시 참고해야 하는 지침입니다.

1. 문체 및 작성 규칙

FAQ는 사용자가 직접 읽는 안내서이므로 친절하고 전문적인 어조를 유지해야 합니다.

• 기본 톤앤매너: "해요체"와 "합쇼체(다나까)"를 적절히 혼용하되, 지나치게 딱딱하지 않게 작성합니다. (예: "~입니다", "~하세요", "네! ~가능합니다.")
• 시각적 요소 사용: 설명이 복잡한 경우 가독성을 위해 이모지를 적극 활용합니다.
  • 긍정/강조: 네!, 💡
  • 절차/순서: ①, ②, ③
  • 주의사항: ⚠️, 💡 (참조)
• 응답 구조: answer 필드는 문자열 배열(string[]) 형태로 작성하며, 한 문장 혹은 한 단락(절차 등)이 끝날 때마다 새로운 배열 요소로 분리하여 코드의 가독성과 프론트엔드 줄바꿈 처리를 돕습니다.

2. 파일 동기화 규칙 (매우 중요)

프로젝트 구조 상 FAQ 데이터는 프론트엔드와 백엔드(Cloud Functions) 양쪽에서 사용됩니다. 따라서 하나만 수정하면 데이터 불일치 또는 치명적인 오류가 발생할 수 있습니다.

반드시 아래 두 파일을 동일하게 수정해야 합니다.

1. src/lib/faqData.ts (프론트엔드용)
2. functions/src/faqData.ts (백엔드용)

두 파일의 FAQ_ITEMS 배열 구조와 내용은 100% 동일하게 유지되어야 합니다.

3. 데이터 구조 명세

추가되는 데이터는 FAQItem 인터페이스를 정확히 따라야 합니다.

export interface FAQItem {
    id: string;      // 영문 케밥 케이스(kebab-case). 예: "new-feature-guide"
    question: string; // 사용자의 입장에서 작성된 질문. 예: "새로운 기능은 어떻게 쓰나요?"
    answer: string[]; // 절차별로 나눈 문자열 배열.
}

[작성 예시]

{
    id: "admin-edit-log",
    question: "권한을 가진 관리자는 다른 직원의 운행일지를 수정하거나 대신 작성할 수 있나요?",
    answer: [
        "아니요. 관리자라 하더라도 타인의 운행 기록을 임의로 수정하는 기능은 제공하지 않습니다.",
        "차량운행일지는 국세청 증빙 및 책임 소재를 명확히 하기 위해 **'작성자 본인'만 자신의 일지를 수정**할 수 있도록 설계되어 있습니다.",
        "내용에 오류나 누락이 발견된 경우, 관리자가 임의로 수정하시는 대신 해당 직원(작성자)에게 직접 수정을 요청해 주시기 바랍니다."
    ],
}

4. 완료 및 배포 확인

파일 수정이 완료되면, 변경된 코드가 안전하게 작동하는지 린팅을 통해 점검하고 필요시 배포 워크플로우를 제안합니다.

1. 로컬 검증:
   • npm run lint 및 타입스크립트 에러 점검
2. 배포 워크플로우 연계:
   • 프론트엔드와 백엔드 코드가 모두 수정되었으므로, 사용자에게 다음의 명령어를 실행할지 물어봅니다.
   • 프론트엔드 배포: /deploy-hosting 워크플로우 사용 권장
   • 백엔드 배포: /deploy-functions 워크플로우 사용 권장 (또는 사용자가 원한다면 /deploy로 전체 배포)