기억하기 회상하기

여러 해가 지나도 문서가 계속 가치를 지니는 이유 가운데 하나는 참조 자료로서의 유용성입니다. 매개변수, 오류 코드, 허용값처럼 외울 수 없었던 정보 조각을 기억하고, 회상하고, 되찾고, 찾아보기 위해 매뉴얼을 훑습니다.

기억을 돕는 문서의 예로는 Dockerfile 참조 문서와 GitLab CI/CD YAML 구문 참조 문서가 있습니다. 사용자가 여러 기술적 “주문”을 실행하기 위해 되새겨야 하는 세부 정보를 검색하기 쉽고 고도로 구조화된 형태로 제공합니다.

참조 문서는 제품을 장기적으로 사용할 수 있게 하는 기반입니다. 다른 행동을 충족하기 위한 문서는 한 번 읽고 내재화할 수 있지만, 참조 자료는 사용자가 전문성을 쌓고 점점 더 정교한 구현을 다루는 동안 계속해서 가치를 발휘합니다.