답변1
음, jjdb에도 불구하고 다음과 같이 성공했습니다.
사용자 문서 = 사용자 가이드, 코드 문서 = 프로그래머 가이드
나는 좀 더 시적으로 표현하려고 노력할 것입니다.
사용자 가이드는 이름에서 알 수 있듯이 사용자, 즉 컴퓨터 뒤에 앉아 필요한 모든 작업을 수행하기 위해 코드를 사용하는 사용자가 사용하기 위한 것입니다.
문서화 코드는 프로그래머가 자신이 하고 있는 일을 추적하고, 코드를 만지고 싶어하는 모든 사람에게 명확한 메시지를 남기고, 정신을 온전하게 유지하기 위해(특히 장기간 작업에서 돌아올 때) 따르는 모범 사례의 일부입니다. 코드와 상호 작용이 없습니다).
기본적으로 사용자 문서는 가능한 한 설명적이어야 합니다. 왜냐하면 그것을 읽는 사람의 패키지에 대한 이해 수준이 어느 정도인지 모르기 때문입니다. (이것이 첫 번째 버전이라면 아무도 본 적이 없을 가능성이 크다는 점을 기억하십시오. 이전에) 코드 문서는 코드가 수행하는 작업과 수행 위치를 보여 주는 방향으로 이루어져야 수정이 가능한 한 쉽게 이루어질 수 있습니다.