피드로 돌아가기
Making sense of this mess
Hugging Face BlogHugging Face Blog
Career

Hugging Face가 Transformers 문서를 Diátaxis 기반 엄격한 구조에서 유연한 통합 모델로 재설계해 개발자 중심의 코드-우선 접근 방식 도입

Making sense of this mess

2024년 6월 7일7intermediate

Context

Transformers 문서는 초기에 머신러닝 엔지니어와 연구자를 위해 텍스트 모델 중심으로 작성되었으나, 3년간 컴퓨터 비전, 오디오, 멀티모달 모델과 LLM, 최적화 기법 등이 점진적으로 추가되면서 구조가 혼재되고 네비게이션이 복잡해졌다. Diátaxis 프레임워크의 4가지 카테고리에 콘텐츠를 강제로 맞추는 과정에서 같은 주제가 여러 섹션에 산재되는 문제가 발생했다.

Technical Solution

  • 타겟 사용자 전환: 머신러닝 연구자 중심에서 AI 제품 개발 중심의 소프트웨어 개발자로 재정의
  • 코드-우선 접근법 도입: 코드 예제를 먼저 제시하고 초급 머신러닝 개념을 긴밀하게 결합해 초보자 친화적 온보딩 제공
  • 점진적 학습 경로 설계: 기본 이해도 달성 후 단계별로 Transformers 심화 지식 습득 가능하도록 구조화
  • 엄격한 구조에서 유연한 구조로 전환: Diátaxis의 가이드 역할을 유지하되 콘텐츠가 자연스럽게 성장·진화할 수 있도록 허용
  • 트리링 모델에서 통합 모델로 변경: 연대기적 계층화(텍스트 → LLM → 최적화 시대)에서 콘텐츠가 전체 문서의 일부로 자연스럽게 공존하는 형태로 리설계

Key Takeaway

문서 구조를 위한 프레임워크가 도움이 될 수 있지만, 획일적 적용보다 사용자의 실제 상호작용 방식과 시간에 따른 도메인 진화를 반영해야 한다. 기술 문서는 미리 정의된 카테고리에 맞추기보다 유연한 통합을 통해 콘텐츠가 자연스럽게 층화될 수 있는 구조가 필요하다.


오픈소스 또는 멀티 도메인 기술 문서를 관리하는 조직에서는 타겟 사용자의 구체적인 상호작용 패턴(예: 코드 예제 우선 검색 vs. 개념 학습 우선)을 파악해 콘텐츠 구성을 재조정하고, 엄격한 분류 체계보다 주제별 통합과 단계별 심화를 중심으로 재구조화하면 네비게이션 복잡도를 낮추고 신규 사용자의 진입 장벽을 줄일 수 있다.

원문 읽기