Skip to content

Portal Foundation 문서 운영 원칙 ​

목적과 적용 범위 ​

Portal Foundation Guide는 포탈 플랫폼에서 재사용되는 공통 UI, 보안·권한, 사용자·조직 동기화, 전문용어 사전, 운영 자동화와 배포 지침의 단일 기준 저장소다. 이 원칙은 신규 가이드뿐 아니라 UI Center 및 DirectoryService에서 중앙 지침 성격으로 작성된 기존 문서를 이관·관리하는 데 적용한다.

단일 기준 원칙: 동일한 운영 절차나 인터페이스 계약은 한 곳에서만 정본으로 유지한다. 구현 저장소의 README·주석·운영 메모에는 정본 문서의 상대 링크 또는 URL만 둔다.

문서 배치 규칙 ​

문서 성격저장 경로설명
포탈 공통 개발 원칙docs/ 또는 docs/foundation/프레임, 디자인 토큰, 공통 패키지 계약, 도메인 확장 규칙을 기록한다.
신규 포탈 생성·배포docs/provisioning/입력값, 자동 설정, 공급자별 절차, 비밀값 전달과 복구를 기록한다.
UI Center·공통 UIdocs/ui-center/공통 UI 템플릿, 릴리스, 위임 접근, 배포 이력을 기록한다.
보안·운영 정책docs/security/, docs/operations/키 관리, 감사, 장애 대응, 데이터 보호 원칙을 기록한다.
문서 체계 자체docs/governance/이 문서처럼 분류·소유·개정 원칙을 기록한다.

작성과 개정 절차 ​

문서는 기능 구현 전에 초안을 두고, 구현의 실제 계약이 확정되면 입력 제약·오류 처리·보안 경계까지 반영한다. 구현 저장소의 코드와 달라졌거나 운영 전제가 바뀌면 문서도 같은 변경 묶음에서 갱신한다. 더 이상 유효하지 않은 문서는 삭제하기보다 상단에 대체 문서와 종료 사유를 표시해 과거 운영 이력을 추적할 수 있게 한다.

책임수행 내용
기능 구현자코드 변경과 함께 정본 가이드를 갱신하고 구현 저장소의 중복 본문을 제거한다.
플랫폼 운영자비밀값·배포·권한 관련 절차의 운영 가능성과 최소 권한 원칙을 검토한다.
포탈 관리자포탈별 메뉴, 도메인 기능, 운영 역할처럼 포탈별 설정이 필요한 부분을 검토한다.

이관 정책 ​

UI Center와 DirectoryService에서 이미 사용된 문서는 이 저장소로 내용을 보존한 채 이관한다. 이관 시 원래 파일명과 문서의 배경을 유지하되, 새 정책이나 구현으로 대체된 경우에는 중앙 문서 센터의 최신 문서를 우선한다. 기능 저장소의 원문 삭제는 각 저장소의 변경 이력·배포·참조 상태를 확인한 뒤 별도 변경으로 진행한다.

References ​