Skip to content

docs: 온보딩 진입 개선과 메인테이너 문서 분리#105

Merged
haksungjang merged 1 commit into
mainfrom
docs/onboarding-improvements
Jun 11, 2026
Merged

docs: 온보딩 진입 개선과 메인테이너 문서 분리#105
haksungjang merged 1 commit into
mainfrom
docs/onboarding-improvements

Conversation

@haksungjang

Copy link
Copy Markdown
Member

배경

SCA 도구를 처음 써보는 한국 기업 담당자, 오픈소스 신규 담당자, 윈도우 사용자가 저장소에 처음 들어왔을 때의 경험을 점검했습니다. 핵심 실행 경로(데스크톱 앱 더블클릭, notice-quickstart.md)는 잘 설계돼 있으나, 첫 진입(README)과 문서 폴더 구조에서 마찰이 있어 이를 개선합니다.

변경 내용

README 진입 개선

  • 배지 직후에 역할 기반 "Where to start" 분기 블록을 추가했습니다. 신규 사용자가 기능 설명을 읽기 전에 세 갈래(빠른 시작 / 시작하기 / 기여)로 자기 경로를 바로 찾습니다.
  • 기존에 두 곳에서 반복되던 "no command line" 빠른 시작 링크를 분기 블록으로 통합했습니다.
  • Documentation 섹션의 한국어/영어 안내를 명확히 했습니다.

docs/ 폴더 정리

  • 메인테이너용 내부 문서(direction-study, desktop-app-study, improvement-roadmap)를 docs/internal/로 옮겨 사용자 가이드와 분리했습니다. 폴더 성격을 설명하는 docs/internal/README.md를 추가했습니다.
  • 이동으로 깨지는 참조 링크를 모두 보정했습니다(README, CHANGELOG, architecture, firmware-analysis, notice-security-ui-guide, supplier-sbom-analysis, electron/README).

.gitignore 보강

  • NOTICE/risk-report/security/conformance/scancode/서명 산출물 패턴을 추가해 샘플 산출물이 실수로 커밋되지 않도록 했습니다.

검증

  • 옛 링크 경로 잔존 없음
  • 루트 샘플 산출물이 모두 gitignore로 무시됨, 정식 추적 문서 오탐 없음
  • README 문체 훅(check-doc-style.sh) 통과
  • scripts/·docker/ 변경 없음 — 통합 테스트 영향 없음

- README: add a role-based 'Where to start' block right after the badges so
  new users (license managers, Windows, non-developers) branch to their path
  before the feature prose; fold the duplicated no-CLI quick-start links into it
- Move maintainer-only docs (direction-study, desktop-app-study,
  improvement-roadmap) into docs/internal/ and fix all referencing links
- gitignore: ignore NOTICE/risk-report/security/conformance/scancode/sig
  deliverables so sample outputs are not committed by accident
@haksungjang haksungjang merged commit 322383c into main Jun 11, 2026
23 checks passed
@haksungjang haksungjang deleted the docs/onboarding-improvements branch June 11, 2026 12:35
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.

1 participant