Discourse 전반에 Meta의 관련 Docs로 연결되는 힌트를 더 추가해 주세요

[traceymoko (Tracey)]

배경

Discourse 팀은 여러 곳에서 관리자 경험(admin experience)을 개선하고자 한다고 언급했습니다.

설정 및 사용자 지정의 악의적인 튕김 성

한 이야기를 해볼까… 대략 1년 전의 일이다. 나는 @awesomerobot의 추천 덕분에 2007년부터 사용해 온 phpBB 데이터베이스를 현재의 시대에 더 적합한 환경으로 이관하는 과정에 있었고, 마침내 내 첫 Discourse 포럼을 세팅하고 있었다. 시스템 관리자가 마법사(wizard)의 첫 단계를 마친 후(“바로 시작하세요!”라고 알려주기 전에) 키를 넘겨주었고, 이제 제대로 설정하는 것은 내 차례였다. 나는 관리자 패널에 들어가서 설정을 열었다. 첫 번째 페이지인 'Required(필수)'에는 내가 찾고 있던 기본적인 항목들이 몇 가지 있었지만…: “exclude rel nofollow domains”(rel nofollow 도메인 제외)? “site contact username… if left blank, the system account will be used”(사이트 연락처 사용자명… 비워 두면 시스템 계정이 사용됨)? 이런 것들은 분명히 선택 사항처럼 보이지 않…

@HAWK

@LWinterberg

오히려 관리자 온보딩(onboarding)과 정보 구조의 전면적인 재편성이 필요할 가능성이 높습니다.

이 부분이 현재 적극적으로 개발 중이라는 소식을 전해드리면 기쁘실 것입니다. Discourse의 내부 구조가 얼마나 복잡하게 느껴질 수 있는지를 잘 알고 있으며, 이를 더 쉽게 만들 수 있는 점진적인 방법들에 집중하는 제품 매니저들이 있습니다.

@mcwumbly

앞으로 해야 할 일이 많지만, 우리는 이러한 문제들에 상당한 관심을 기울이고 있습니다. 직전 릴리스에서는 특히 사이트 설정 경험에 노력을 기울였습니다. 이번에 나올 릴리스에서는 관리자 경험 전반의 개선과 플랫폼의 확장성 향상에 초점을 맞추고 있습니다.

문제

Discourse에는 설정이 많고 문서도 방대합니다. 하지만 필요한 순간에 올바른 문서를 찾기는 쉽지 않습니다.

기능 제안

Discourse의 설정과 메뉴에서 https://meta.discourse.org/docs에 있는 해당 문서를 링크할 수 있는 곳이 훨씬 더 많을 수 있습니다.

예를 들어, Discourse 설치 환경에 링크되어 있는 Understanding Discourse Trust Levels 블로그 게시글이 있습니다.

하지만 링크가 없는 문서들이 훨씬 더 많습니다.

예를 들어, 카테고리를 삭제하는 방법에 대한 안내 문서가 있습니다.

Deleting a category

This guide explains how to delete a category in Discourse, including the necessary steps to move or delete topics within the category and handle special cases like the “Uncategorized” category. Required user level: Administrator (or Moderator if moderators_manage_categories is enabled) Deleting a category in Discourse involves two main steps: Moving or deleting all topics within the category Deleting the empty category This guide will walk you through both…

카테고리 삭제 버튼을 볼 수 있는 모달 창에 이 문서를 포함하는 것이 관련성 있고 유용할 것 같습니다.

링크일 수도 있지만, 모든 경우에 반드시 링크일 필요는 없습니다. 문서로 연결되는 물음표 버튼이나 “더 보기…” 등으로도 가능합니다.

Discourse 팀은 주요 문서부터 시작하여 문서들을 살펴보고, 소프트웨어 내에서 해당 문서로 연결하는 것이 가장 적절한 위치가 어디인지 파악할 수 있습니다.

(즉, “필요할 때(Just-in-time)”)

The “Just In Time” Theory of User Behavior

다른 소프트웨어 사례

Ghost(오픈 소스 블로그 소프트웨어)는 필요한 순간에 바로 문서로 연결되는 링크가 있는 몇몇 부분이 있습니다.

예를 들어, 이 ‘자세히 보기’ 버튼은 관련 문서로 연결됩니다:

Creating discount and trial offers

여기서도 마찬가지입니다:

Post analytics

Contribute > Feature 또는 Contribute > UX 중 어디에 해당되는지 확실하지 않아, 자유롭게 이동해 주세요.

[LWinterberg]

이 부분에 대해서는 약간 이견이 있습니다. 도움말 콘텐츠에는 다양한 범위가 있습니다. Diátaxis 모델에 따르면 튜토리얼, 어떻게 하는지 가이드(How-to guides), 레퍼런스(참고 자료), 설명(Explanation)으로 나뉩니다.

튜토리얼은 앱 자체 내에 링크가 걸릴 자리가 있을 수 있습니다. "이것이 어떻게 작동하는지 배우고 싶다"는 의도로 특정 페이지에 들어갔을 때, 페이지가 스스로 설명되지 않더라도 배울 수 있도록 말이죠. 심지어 원할 경우 소프트웨어에 대한 과정을 마치기 위한 튜토리얼 센터를 제공하는 것도 가능할 것입니다.

나머지 3개 범위에 대해서는 좀 문제를 제기하고 싶습니다.

카테고리 설정 페이지에 갔을 때, 제가 하고 싶은 일은 20가지가 다를 수 있습니다. 거기에 어떻게 하는지 가이드를 넣는다면 검색해야 하는 목록이 생깁니다. 그리고 제가 찾으려는 것에 전용 가이드 글이 반드시 있을 것이라는 기대가 없기 때문에, 목록을 검색하기보다는 그 질문을 Google에 입력할 가능성이 높습니다.

외부 사이트의 레퍼런스는 매일 마주해야 하는 골칫거리입니다. 우리는 각 슬라이더와 버튼이 무엇을 하는지, 심지어 다음과 같은 수준까지 알려주는 "레퍼런스 매뉴얼"이 있습니다:

취소 버튼: 변경 사항을 적용하지 않고 다이얼로그를 닫습니다.
확인 버튼: 변경 사항을 적용하고 다이얼로그를 닫습니다.

이 레퍼런스를 사용하려면 정말로 필요한 것은 몇 단어 더 풀어 쓴 옵션의 툴팁인데, 해당 섹션에 도달하기 전에 엄청나게 많은 기술적 내용을 스크롤해야 합니다.

카테고리를 삭제하려고 하면, 현재 동작은 거의 바람직합니다. 보통 회색으로 비활성화되어 있지만 물음표가 있는 버튼을 보고 클릭하면 다음과 같이 표시됩니다:

하위 카테고리가 있어 이 카테고리를 삭제할 수 없습니다.

또는:

25,852개의 주제가 있어 이 카테고리를 삭제할 수 없습니다. 가장 오래된 주제는…

이 동작은 좋습니다. 무엇이 문제인지, 다음 단계(포스트와 하위 카테고리를 삭제하는 것)가 무엇인지 알 수 있기 때문입니다. 대신 “카테고리 삭제” 어떻게 하는지 가이드로 링크를 걸면 더 좋아지지는 않을 것입니다.

물론, 이것은 여전히 근본적인 문제에 대한 임시 처방입니다: 포스트가 있는 카테고리를 왜 삭제하지 못하게 하는가? 제 시스템에서는 하위 폴더와 파일이 있는 폴더를 삭제할 수 있는데, 왜 하위 카테고리와 포스트가 있는 카테고리는 삭제할 수 없습니까? 이러한 이상한 제한이 없다면 애초에 앱 내에 어떻게 하는지 가이드가 필요하지도 않았을 것입니다.

마지막으로, 설명(Explanation)은 “신뢰 수준 이해하기” 블로그 포스트와 같은 것입니다. 처음 만났을 때 꽤 혼란스러웠습니다 - “6년 전의 랜덤한 블로그 포스트가 문서로 가진 최선인가?” - 그리고 모든 것을 표로 나열한 레퍼런스 글로 링크를 걸고 있는데, 이는 제 기대(정렬 방식은 예상과 달랐지만)에 더 부합했습니다. 설명은 특정 작업을 직접 수행하는 데 도움이 되지 않으므로, 작업이 완료되는 위치에 두는 것은 잘 작동하지 않습니다.

---

결론적으로, 문서화가 몇몇 곳(예: 온보딩이나 디자인이 실패한 경우)에서는 중요하지만, 정말로 주목해야 할 것은 디자인이라고 생각합니다. 웹사이트를 설명해 주는 사람(또는 영상)을 읽거나 보는 것은 거의 항상 원하는 경험이 아닙니다.

[traceymoko (Tracey)]

@LWinterberg

결국 문서화가 몇몇 부분(예: 온보딩, 또는 디자인이 실패하는 경우)에서는 중요하지만, 궁극적으로 초점은 디자인에 맞춰져야 한다고 생각합니다.

네, 과거 게임 디자인을 전공했던 입장에서 이 의견에 전적으로 동의합니다. (Audacity의 디자이너셨죠? 참고로 저는 Audacity를 많이 사용하는데, 정말 감사하게 생각하고 있습니다!)

전체 경험을 처음부터 다시 재구성해야 한다고 생각합니다. 모든 사용 사례에 대해 "관리자가 무엇을 하고 싶어 할까, 그리고 우리는 어떻게 하면 그들을 가장 잘 도울 수 있을까?"라고 생각하며 시작하는 것이죠. 이렇게 하면 프로세스가 훨씬 더 잘 전달될 뿐만 아니라, 프로세스 자체도 최대한 직관적으로 만들 수 있습니다.

여기서 제시된 예시(카테고리에 토픽이 있는 경우 삭제를 허용하지 않는 경우)를 들면, 소프트웨어가 이를 더 우아하게 처리하는 방식이 다음과 같을 수 있습니다. 토픽이 있는 카테고리를 삭제하려고 할 때, 먼저 다음 중 어떤 것을 원하시는지 제안할 수 있습니다:

• 기존 모든 토픽을 다른 카테고리로 이동하거나,
• 기존 모든 토픽을 '분류되지 않음(Uncategorized)'으로 이동하거나,
• 해당 카테고리의 모든 토픽을 삭제하는 것

그리고 나서 카테고리를 삭제하려는 것을 확인하는 방식입니다.

Discourse 팀이 이 단계에서 점진적인 변화를 추구하고 있다는 것을 알 수 있었습니다:

@HAWK

@LWinterberg

사실 그것은 관리자 온보딩과 정보 구조 모두에 대한 전면적인 재편성이 필요할 가능성이 큽니다.

이것이 현재 활발하게 개발 중이라는 소식을 전해드리면 기뻐하실 것입니다. 우리는 Discourse가 내부적으로 얼마나 복잡한지 잘 알고 있으며, 이를 더 쉽게 만들기 위한 점진적인 방법들에 집중하는 프로덕트 매니저들이 있습니다.

저는 좀 더 손쉬운 해결책(즉, ‘낮은 열매’)을 요청한 것입니다 — 가장 관련성이 높은 곳에 가장 인기 있는/일반적인/주요 문서에 대한 링크를 추가하는 것이죠.

(여기서 논의한 카테고리 삭제 경험 개선에 대한 피드백/제안을 나중에 새로운 토픽으로 만들 수도 있습니다.)

[hugh (Hugh Lashbrooke)]

@traceymoko

Discourse 설정과 메뉴에서 https://meta.discourse.org/docs에 있는 관련 문서로 연결되는 곳이 훨씬 더 많을 수 있습니다.

이 제안에 매우 공감합니다. @traceymoko 님, 지적해 주셔서 감사합니다! 현재 문서의 일반적인 구조와 분류를 개선하는 작업을 진행 중이며, 이러한 기능이 해당 과정의 일환으로 고려할 가치가 있다고 생각합니다. 문서 로드맵에 탐색해 볼 항목으로 추가하고, 최적의 구현 방법을 검토해 보겠습니다.

[pacharanero (Marcus Baw)]

오래된 주제를 다시 꺼내서 죄송합니다. 현재 진행 중인 관리자 검색 및 전체 관리자 경험 개선 작업에 대해 잘 알고 있습니다. 지난 몇 주 동안 여러 번, 각 사이트 설정의 이름이 Meta의 관련 문서 주제로 연결되는 링크였으면 좋겠다고 생각했습니다. 지난 몇 년간 Meta 문서는 크게 개선되어 이제 상당히 포괄적이고 체계적이며 정보량이 풍부합니다.

예시:

위 예시에서는 "백업 위치"가 Configure automatic backups for Discourse 같은 Meta 주제로 연결되기를 원합니다.

점진적으로 이러한 사이트 설정 이름 각각이 관련 Meta 스레드로 연결되는 단계에 도달할 수 있을까요? Discourse 코드에 URL을 하드코딩하는 것은 원치 않을 수 있다는 점을 이해하지만, 어쨌든 사이트 텍스트(Site Texts)에 이를 포함할 수 있을 것 같습니다.

이 모든 링크 작업을 수행하는 것은 상당한 규모이지만, 여러 셀프호스터들의 집단적 노력으로 가능할까요?