문서 작성과 검수 기준
2026년 9월
Shardmonics 문서가 단순 홍보 문구가 아니라 실제 사용 지식으로 유지되기 위한 기준입니다.
문서의 목적
Shardmonics의 문서는 기능 소개보다 사용자의 판단을 돕는 설명을 우선합니다. 버튼 위치만 나열하는 글은 기능이 바뀌면 금방 쓸모가 없어지기 때문에, 왜 그 순서로 작업해야 하는지와 어떤 상황에서 예외가 생기는지를 함께 적는 것을 기준으로 삼습니다.
좋은 문서는 사용자가 곧바로 작업을 이어갈 수 있게 합니다. 예를 들어 “MusicXML을 업로드하세요”에서 끝나는 것이 아니라, 어떤 프로그램에서 내보낸 파일이 안정적인지, 어떤 정보가 누락되면 분석이 흔들리는지까지 설명해야 합니다.
수정과 검수
문서가 실제 제품 상태와 달라지면 기능보다 문서가 사용자를 더 혼란스럽게 만들 수 있습니다. 그래서 기능 이름, 버튼 텍스트, 분석 심각도, 커뮤니티 규칙이 바뀌면 관련 문서도 함께 확인하는 방식으로 관리합니다.
음악 이론 설명은 가능한 한 단정적인 표현을 피합니다. 화성 분석은 장르와 시대 양식에 따라 달라질 수 있으므로, “항상 틀림”보다 “현재 기준에서 먼저 검토할 항목”처럼 사용자가 판단할 여지를 남기는 표현을 사용합니다.