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

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

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

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

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

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

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

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

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

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

또는:

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

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

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

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


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

5개의 좋아요