Skip to content

docs: 문서 흐름 규칙 및 discussions 템플릿 정리#64

Merged
oneplast merged 1 commit intodevfrom
docs/##_문서화_구조_보강
Apr 6, 2026

Hidden character warning

The head ref may contain hidden characters: "docs/##_\ubb38\uc11c\ud654_\uad6c\uc870_\ubcf4\uac15"
Merged

docs: 문서 흐름 규칙 및 discussions 템플릿 정리#64
oneplast merged 1 commit intodevfrom
docs/##_문서화_구조_보강

Conversation

@oneplast
Copy link
Copy Markdown
Collaborator

@oneplast oneplast commented Apr 6, 2026

📝 Part (해당되는 것만 체크)

  • BE
  • FE
  • Infra
  • Docs
  • Test

#️⃣ 연관된 이슈

No response


🔎 작업 내용

1. 주요 변경 사항 요약

  • 문서화 구조 정리
    • 문서 흐름 규칙 정리
    • 문서 간 중복 제거 기준 정리
    • 외부 공식 자료 표기 기준 정리
  • 상위 README.md 에 각 하위 README.md 에 대한 전역 규칙 설정
    • 하위 README.md 에서는 기본적으로 상위 README.md 의 규칙을 먼저 따르도록 설정

2. 상세 내용 (선택)

1. 문서 공통 작성 기준을 정리하였습니다.

  • AGENTS.md , docs/README.md 기준으로, 문서 공통 흐름 원칙을 정리하였습니다.
  • 핵심 기준은 아래와 같습니다.
    • 읽는 문맥/흐름 우선
    • 같은 문서 안의 근거/결론 반복 최소화
    • 외부 공식 자료 사용 시, 본문에서 출처 성격 및 해석 여부가 드러나도록 작성

2. discussions 템플릿 구조를 재정리하였습니다.

  • docs/discussions/README.md , docs/discussions/000-strategy-review-template.md 를 수정하였습니다.
  • 기존 '고려한 자료와 사례' 독립 섹션을 제거하고, 필요 시 '배경' 섹션 말미에서 다루도록 기준을 변경했습니다.

3. 하위 README의 중복 규칙을 정리하였습니다.

  • 상/하위 구조에서 각각README.md 가 존재할 경우, 전역 규칙을 상위 README.md 파일에 두었습니다.
  • 이후 하위 README.md 들은 문서화 이전에 상위 README.md 파일 규칙을 먼저 따르도록 설정하였습니다.
  • 하위 README.md 에는 디렉토리 전용 추가 기준만 설정하도록 했습니다.

3. 프롬프트 경로

No response

4. 참조 문서 경로 (ADR, discussions, roadMap ...)

No response


💬 집중 리뷰 요청

  • 변경된 문서화 규칙을 확인해주세요.

🧪 테스트 방법

1. 로컬 실행 방법

No response

2. 테스트 시나리오

No response


✅ PR 체크리스트

  • 불필요한 디버그 로그 / 주석 제거
  • breaking change 여부 확인 및 문서화
  • 신규/변경된 기능에 대한 테스트 코드 추가 또는 기존 테스트 통과
  • 로컬에서 주요 시나리오 수동 테스트 완료
  • 관련 문서(노션, README, API 문서 등) 업데이트

📈 이미지 / 캡처 (필요 시)

No response

@oneplast oneplast self-assigned this Apr 6, 2026
@oneplast oneplast added the documentation Improvements or additions to documentation label Apr 6, 2026
@oneplast oneplast requested review from hellonaeunkim and jho951 April 6, 2026 04:42
@oneplast oneplast merged commit 0a7b0b2 into dev Apr 6, 2026
1 check passed
@oneplast oneplast deleted the docs/##_문서화_구조_보강 branch April 6, 2026 04:42
@github-project-automation github-project-automation bot moved this from Todo to Done in Block-server Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant