Skip to content

[Feat/#74] 시드 문서 실사용 내용으로 교체 - #75

Merged
seungbye merged 5 commits into
mainfrom
feat/#74-seed-docs
Nov 17, 2026
Merged

seungbye merged 5 commits into
mainfrom
feat/#74-seed-docs

Conversation

@seungbye

@seungbye seungbye commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

무엇을 했나

docs/seed/ 문서 10건을 실제 학생회 운영 내용으로 다시 썼다.

문서ID 파일 내용
seed-stream stream-guide.md Stream 4개 탭(홈·행사·게시판·빌릴게) 안내
seed-borrow borrow-guide.md 빌릴게 대여 장소·시간·반납 원칙
seed-locker locker-guide.md 사물함 구역, 신청 자격, 연 단위 배정
seed-event event-guide.md 행사 신청과 취소 경로
seed-feedback feedback-guide.md 열린피드백 제도와 작성 위치
seed-fee fee-guide.md 학생회비 납부 방식과 혜택
seed-office office-guide.md 학생회실 위치와 운영 시간
seed-places places-guide.md 미래관 시설 위치, 교학팀 운영 시간
seed-scope chatbot-scope.md 챗봇이 답하는 범위와 답하지 않는 범위
seed-seullangje seullangje-guide.md 슬랑제 행사 성격

작성 원칙

학기가 바뀌어도 변하지 않는 사실만 적었다. 신청 기간, 행사 날짜, 남은 수량처럼
바뀌는 값은 넣지 않았다. 시드에 박으면 다음 학기에 거짓말이 된다. 그 정보는
공지(notice)와 function calling이 담당한다.

학생회비만 예외로 현재 금액(학기당 2만원, 8학기 선납 16만원)을 적었다.
해마다 바뀔 수 있다는 사실을 같은 문단에 함께 적어 두었다.

범위에서 뺀 것

  • 학교 공식 사이트 정보: 답하지 않기로 했다. 링크도 주지 않는다. chatbot-scope.md에 명시했다.
  • 사물함 반납·취소: 실제로 그 기능이 있는지 확인되지 않아 적지 않았다.

검색 관련

  • 문서 10건 모두 front matter 파싱 통과, 건너뛰는 파일 없음
  • 본문 140~616자로 전부 단일 청크. search.py의 "문서ID당 최상위 청크 1개" 제약에 걸리지 않는다
  • 학생이 쓰는 줄임말을 본문에 함께 넣었다 (자주스, 무상실, 과사, 행정실)
  • 과사(교학팀)와 과방(학생 공간)을 혼동하지 않도록 구분 문장을 넣었다

index/는 gitignore 대상이라 색인 파일은 커밋하지 않았다.

리뷰 요구사항

  • 빌릴게가 학생회비 납부자 전용인지. fee-guide는 혜택으로 적고 있는데 borrow-guide에는 제한이 없다
  • 과방과 학생회실이 같은 곳인지. 둘 다 미래관 3층 306호로 적혀 있다
  • 열린피드백 익명 여부와 답변 주기를 적을지

close #74

리뷰 반영 (추가)

  • 꼭 고쳐야 할 것 3개: 개인 조회 범위(chatbot-scope.md), 빌릴게 납부자 전용(borrow-guide.md), 사물함 진입 경로(locker-guide.md)
  • 학생회 확인 결과: 반납은 당일 원칙이고 개인 사정이 있으면 다음 날 반납할 수 있다. 학생회실은 과방 안에 있다(둘 다 306호). 열린피드백은 익명이다
  • AGENTS.md: 학교 공식 문서(학사공지 등)는 넣지 않고 링크도 주지 않는 방침으로 데이터 분류·답변 규칙·금지 사항을 고쳤다. 학교 홈페이지 수집 항목은 「수집하지 않는다」로 바꿨다([Docs/#71] 슬랑제 전 확정 범위·9주차 재배치와 에이전트·내부 API 설계 문서 #78 로드맵과 같게)

학생회 운영 사실을 확인해 docs/seed/ 문서를 다시 썼다.

- 기존 문서 교체: stream, borrow, locker, event, scope
- 신규 추가: office, places, fee, feedback, seullangje

학기가 바뀌어도 변하지 않는 사실만 적었다. 신청 기간과 행사 날짜,
남은 수량은 넣지 않았다. 시드에 박으면 다음 학기에 틀린 답이 된다.
그 정보는 공지와 function calling이 담당한다.

학교 공식 사이트 정보는 범위에서 뺐다. 링크도 주지 않는다.

학생이 쓰는 줄임말(자주스, 무상실, 과사)을 본문에 같이 넣어
BM25가 학생의 말로도 찾게 했다.
@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7d3cefbe-03dd-434d-b531-ceedc9951826
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@overhyeon overhyeon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

시드 정리 고생 많았어요! 바뀌지 않는 사실만 남기고 줄임말(자주스·무상실·과사)까지 넣어 둔 게 검색에 특히 좋을 것 같아요. 백엔드 코드·골든셋·열린 PR과 맞춰 보면서 걸린 것들 남겨요.

꼭 고쳐야 할 것 (줄 코멘트로도 달았어요)

  1. chatbot-scope.md — #80에서 내 대여·내 사물함 조회 도구가 들어가요. 지금 문장대로면 "내 대여 언제까지야"에 이 문서가 검색돼서 도구를 안 부르고 거절할 수 있어요.
  2. borrow-guide.md — 빌릴게는 학생회비 납부자 전용이 맞아요(질문 1). 백엔드 대여 신청이 payerService.validatePayer로 막고 MEMBER_IS_NOT_PAYER를 내요.
  3. locker-guide.md — "Stream 사물함 탭"인데, 같은 PR의 stream-guide.md는 탭이 4개고 사물함은 홈에서 들어간다고 적혀 있어요.

확인 부탁

  • 반납 "당일 원칙" — 백엔드는 물품마다 최대 대여 일수(maxRentalDays)가 있고, 재고 도구가 그 값을 "최대대여일"로 모델에 넘겨요. 운영 정책이 당일이면 관리자 화면 값도 맞춰야 챗봇이 한 대화에서 "당일"과 "3일"을 섞어 말하지 않아요.
  • 학교 공식 정보 "링크도 주지 않는다" — AGENTS.md는 "제목 + 게시일 + 원문 링크 안내"라서 방침이 달라요. 바꾸기로 한 거면 AGENTS.md 데이터 분류 쪽도 같이 고쳐야 할 것 같아요.
  • 과방과 학생회실(질문 2) — 같은 곳이면 places-guide.md에 "과방(학생회실)"처럼 묶어 두면 덜 헷갈릴 것 같아요. 학생회에 확인이 필요해 보여요.
  • 열린피드백 익명 여부(질문 3) — 백엔드 AI용 응답에서도 작성자를 빼고 있어서 익명이라고 적어도 될 것 같아요. 답변 주기는 바뀔 수 있어서 빼는 게 낫다고 봐요.

골든셋
근거문서ID(seed-borrow·seed-event·seed-locker)는 그대로라 깨지지 않는데, 정답요지 3건이 새 시드와 달라져요. 머지 후 골든셋 재매핑 때 같이 고칠게요.

  • "빌리려면 어디로 가야 해" → 4층 학생회실 → 3층 306호
  • "대여물품 대여시간 안내" → 최대 3일 → 당일 원칙(위 확인 결과에 따라)
  • "빌릴게 설치 어떻게 해" → "홈 화면에 추가" 안내가 시드에서 빠짐

자잘한 것

  • PR 본문이 Closes #N이라 #74가 연결되지 않아요.

Comment thread docs/seed/chatbot-scope.md Outdated
학생회와 관계없는 질문에는 답할 수 있는 범위를 짧게 안내한다.
다른 단과대의 행사는 알지 못한다. 소융대가 다른 단과대와 함께 여는 연합 행사는 학생회 행사이므로 답하지만, 그 단과대가 따로 여는 행사는 알 수 없다는 점을 밝힌다.

개인 정보는 조회하지 않는다. 성적, 이수 학점, 내가 신청한 내역처럼 로그인해야 알 수 있는 것은 종합정보시스템이나 Stream에서 직접 확인하도록 안내한다.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#80에서 내 대여·내 사물함을 학생 본인 권한으로 조회하는 도구가 들어가서, 이 문장과 부딪혀요. 예를 들어 이렇게 바꾸면 어떨까요?

빌릴게 대여 현황과 배정된 사물함은 본인 것만 조회해 준다. 다른 학생의 정보는 알려주지 않는다. 성적, 이수 학점처럼 학교 시스템에 있는 정보는 조회하지 않고 종합정보시스템에서 직접 확인하도록 안내한다.

Comment thread docs/seed/borrow-guide.md
빌릴게는 소융대 학생회가 운영하는 복지물품 대여 서비스다. Stream의 빌릴게 탭에서 쓴다.

빌리는 순서는 Stream 빌릴게에서 예약한 뒤 미래관 4층 학생회실에 가서 학생증을 보여주고 받는 것이다. 반납도 같은 학생회실에서 한다.
빌리는 순서는 Stream 빌릴게 탭에서 물품을 신청한 뒤 학생회실에 가서 학생증을 보여주고 받는 것이다. 반납도 같은 학생회실에서 한다.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

백엔드 대여 신청(RentalApplyUseCase)이 payerService.validatePayer로 회비 납부자인지 확인하고, 아니면 MEMBER_IS_NOT_PAYER로 막아요. 미납자가 "빌릴 수 있어요?"라고 물으면 된다고 답하지 않게 "빌릴게는 학생회비 납부자만 이용할 수 있다" 한 줄 넣어 주세요.

Comment thread docs/seed/borrow-guide.md Outdated
학생회실은 미래관 3층 306호다. 운영 시간은 평일 10:00~17:00이고, 12:00~13:00은 점심시간이라 대여와 반납을 할 수 없다. 주말과 공휴일은 쉰다.

어떤 물품이 있고 지금 몇 개 남았는지는 Stream 빌릴게 화면에서 실시간으로 확인한다. 이 문서에는 재고를 적지 않는다.
반납은 당일이 원칙이다. 다만 우산처럼 사정에 따라 당일에 돌려주기 어려운 물품은 다음 날 반납한다.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

백엔드는 물품마다 최대 대여 일수(maxRentalDays)를 따로 두고 있고, 재고 도구가 이 값을 "최대대여일"로 모델에 넘겨요. 운영 정책이 당일 반납이면 관리자 화면의 값도 그에 맞는지 확인 부탁드려요. 둘이 다르면 챗봇이 서로 다른 기한을 말해요.

Comment thread docs/seed/locker-guide.md Outdated
---

사물함은 Stream의 사물함 탭에서 구역을 고른 뒤 신청한다. 선착순이라 정원이 차면 그 구역은 더 신청할 수 없다.
사물함은 Stream 사물함 탭에서 구역을 고른 뒤 신청한다. 선착순이라 정원이 차면 그 구역은 더 신청할 수 없다.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stream-guide.md에는 탭이 홈·행사·게시판·빌릴게 4개이고 사물함은 홈에서 들어간다고 되어 있어서, 여기도 "Stream 홈의 사물함에서"로 맞추면 좋겠어요. 마지막 문단의 "Stream 사물함 탭"도 같아요.

@seungbye

Copy link
Copy Markdown
Contributor Author

리뷰 고마워요! 꼭 고쳐야 할 것 3개는 f23cb20에 반영했어요.

  1. chatbot-scope.md: 제안해 준 문장 그대로 바꿨어요. 이제 빌릴게 대여 현황과 배정된 사물함은 본인 것만 조회한다고 적혀 있어요
  2. borrow-guide.md: "빌릴게는 학생회비 납부자만 이용할 수 있다" 한 줄 넣었어요
  3. locker-guide.md: "Stream 사물함 탭"을 세 군데 모두 "Stream 홈의 사물함"으로 바꿨어요
  • PR 본문도 close #74로 고쳐서 이슈를 연결했어요

확인 부탁 항목(반납 당일 원칙과 maxRentalDays, 학교 공식 링크 방침, 과방과 학생회실, 열린피드백 익명 여부)은 학생회에 확인한 뒤 따로 반영할게요.

@seungbye

Copy link
Copy Markdown
Contributor Author

확인 부탁 항목도 학생회 확인 결과대로 반영했어요 (17bd847).

  • 반납: 당일이 원칙이고, 개인 사정이 있으면 다음 날 반납할 수 있어요. borrow-guide.md를 이렇게 고쳤어요. 관리자 화면의 maxRentalDays 값도 이 원칙에 맞는지 같이 봐 주세요
  • 과방과 학생회실: 학생회실은 과방 안에 있는 학생회 전용 방이라 둘 다 306호예요. places-guide.md와 office-guide.md에 적었어요
  • 열린피드백: 익명이 맞아서 그 내용을 넣었어요. 답변 주기는 원래 문서에 없었고 앞으로도 넣지 않을게요
  • 학교 공식 정보: 학사 공지 같은 학교 공식 문서는 챗봇에 넣지 않기로 했어요. 그래서 chatbot-scope.md는 그대로 두고, AGENTS.md 데이터 분류를 이 방침에 맞게 고칠 예정이에요

@seungbye
seungbye merged commit 9d2eece into main Nov 17, 2026
1 check passed
@seungbye
seungbye deleted the feat/#74-seed-docs branch November 17, 2026 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feat] 시드 문서 실사용 내용으로 교체

2 participants