나는 상사가 읽고 읽고 싶어하는 설명이나 해설을 한 줄씩 (또는 이미지별로 이미지 등으로 적절하게) 제공해야합니다.
그는 프로그래머가 아니기 때문에 코드를 따라갈 수 없으므로 모두 영어로 번역되기를 원합니다.
전에이 작업을 수행 한 사람이 있습니까?
나는 모든 소스 코드에 주석을 달았고 JSDoc 을 사용 하여 모든 함수, 변수 등에 대한 완전한 문서를 생성했으며 구현 예제와 전체 작업 주석을 포함한 전체 데모를 포함시켰다.
프로그래머가 아닌 사람을 위해 코드에 주석을 달기 위해 할 수있는 다른 일이 있습니까?
이것은 합리적인 요청이 아닙니다. 그렇지 않습니까?
최신 정보
결국, 나는 그가 요청한 것을하는 데 시간을 잘 사용하지 않는 이유를 설명 할 수있었습니다. 그는 합리적인 사람이며, 내 직업이 무엇인지 이해하지 못했습니다. 그가이 게시물을 보았을 때, 나는 그것이 정상적인 요청이 아니라는 것을 빨리 이해했다고 생각합니다.
나는 다른 프로그래머가 따르기에 적합한 문서 (JSDoc 및 인라인 주석-기술적 문제에 대한 추가 참고 사항)와 상사가 따라야 할 프로그램의 주요 논리에 대한 매우 광범위한 흐름도를 제공했습니다.
결국, 모든 당사자들이 만족했고 우리는 전진했습니다.