문서 개선을 위한 디아택시스 프레임워크 도입

개요

• Sequin 팀은 Diátaxis 프레임워크를 통해 문서화를 개선.
• 초기 설명 방식에서 사용자 이해의 문제를 경험.

엔지니어의 문서화 오류

• 엔지니어들은 제품 작동 방식 설명에 집중.
• 사용자 이해에 어려움 발생.

Diátaxis란?

• 문서화를 위한 프레임워크로 네 가지 카테고리로 분류.
• 독자의 문서 탐색 도움.

네 가지 문서 카테고리

1. 튜토리얼 (Tutorials): 초보자 실습용 단계별 안내 문서.
2. How-to 가이드 (How-to guides): 문제 해결을 위한 단계별 방법 제공.
3. 참고 자료 (Reference): 기술적 정보로 신속한 참고 가능 문서.
4. 설명 (Explanation): 배경 지식과 깊이 있는 이해 제공 문서.

도입 결과

• 사용자 이해 및 활용도 향상.
• 카테고리에 맞는 문서 작성으로 경험 개선.