어떤 사람들은 말 없이는 생각할 수없는이 문제가 있습니다. 그리고 그들의 생각과 결정을 적는 것이 가장 효과적인 방법입니다.
따라서 코딩하는 동안 메모장 ++ 파일에 생각과 결정을 적어 두는 것이 일반적이며 수용 가능합니까?
예를 들어 기술 문서를 다시 작성하거나 더 복잡한 알고리즘에 대한 추론을 할 때 허용되는 경우도 있지만 설계 옵션을 고려하고 판단하려고 할 때 이상 할 수 있습니다.
이 관행이 생산성에 미치는 영향은 명확하지 않습니다. 한편으로는 내면의 단어를 사용한 추론이 글을 쓰는 단어보다 빠를 수 있습니다. 다른 측면에서-더 복잡한 문제는 쓰기가 필요합니다. 게다가, 더 많은 디자인 옵션을 고수하면 결정이 내려 질 때 느낌이 좋아져 사기가 높아집니다.
답변
정상일뿐만 아니라 좋은 생각입니다.
유명한 인용문이 있습니다
“나무를 자르려면 6 시간을 줘라. 그러면 도끼를 깎는 첫 4 시간을 보내겠다.”
코딩하기 전에 시간을내어 생각을 정리하고 작업을 계획하는 데 많은 시간이 소요됩니다. 이러한 생각을 종이에 적어두면 계획을 숙고하고 비평하며 “머리 만”하면 매우 어려운 방식으로 계획을 정리할 시간을 갖게됩니다.
답변
예, 이것은 완벽하게 허용되며 정상입니다.
의사 결정 프로세스를 문서화하면 코드를 다시 방문 할 때 코드가 특정 방식으로 작성된 이유를 파악하는 데 도움이되는 경우가 종종 있습니다.
이 메모는 코드에 주석으로 직접 포함될 수 있습니다. 확장 된 주석은 종종 외부 기술 설계 문서의 일부로 유지됩니다.
답변
좋은 생각이야 미루는 방법이 될 때까지
열쇠는 균형입니다. 나는 내 자신을 상자에 넣지 않고 그들이 올 때 아이디어를 포착하면 가장 생산적이라고 생각합니다.
낮은 수준에서 연삭하고 높은 수준의 아이디어가 나오면 그냥 적어두고 나중에 다시 돌아옵니다.
일을 계획하는 것은 좋은 생각이지만 관중들 앞에서 의사 소통을하거나 발표하지 않으면 최고의 도구는 펜과 냅킨입니다. 아이디어를 포착하십시오. 예쁘게 만드는 데 시간을 낭비하지 마십시오.
답변
모든 전문적인 상황에서, 그것은 “정상적이고 수용 가능”할뿐만 아니라 필수입니다. 일반적인 개발주기는 코딩이 시작되기 전에 두 가지 문서화 단계로 구성됩니다.
-
기능 요구 사항 문서 : 일반적으로 비즈니스 분석가가 작성하고 구현할 기능을 지정합니다.
-
상세 설계 문서 : 꽤 많이 당신이, 알고리즘 등 내 (매우) 오래된 것들의 일부를 시스템의 기능 분해 (인수)를 지정, 단지 형식적인, 무슨 말을하는지입니다, 온라인 예이다 이 .
덜 공식적인 문서의 경우, 110 %는 인라인 주석에 대한 이전의 언급에 동의합니다. 이것이 유일한 길입니다. 어떤 식 으로든 다른 모든 것은 결국 없어집니다. 그러나 깔끔하고 사려 깊은 인라인 주석은 다른 기술과 마찬가지로 노력과 연습을 통해 개발 된 별도의 코딩 기술입니다. 예를 들어 this 에서 내 (매우) 오래된 것들을 볼 수 있습니다 . 그 스타일은 당신에게 호소력이 있거나 그렇지 않을 수 있습니다. 먼저 원하는 스타일로 잘 작성된 코드를 찾아서 자신의 코드로 에뮬레이션하는 것이 좋습니다. 잠시 후, 적합하다고 생각되는대로 조정하십시오.
답변
이러한 종류의 정보를 넣을 수있는 좋은 장소는 버전 제어 시스템 (SVN, git 등)의 커밋 메시지에 직접 있습니다. 이렇게하면 같은 장소에서 변경 사항과 추론을 볼 수 있습니다.
답변
다른 좋은 답변 외에도, 내가하려는 일에 대한 생각을 자주 적어 놓는다.
내가하려는 일을 명확하게 표현하면 필연적으로 요구되지 않는 가정, 가정 및 / 또는 요구 사항을 실현할 수 있습니다.
그런 다음 대안을 암시하고 차례로 대안을 제시합니다. 다른 글을 생각하면 저의 자리를 구하는 데 도움이되는 글입니다.
호흡과 심도를 탐색하기 위해 빠른 메모를 작성하므로 재귀 적으로 작동하여 솔루션 트리를 정교화하고 탐색하고 평가하여 백업, 탐색, 발견, 실현 및 결정을 도와줍니다.
답변
당신 / / (새로운) 팀원의 시간을 절약 할 수있는 모든 것을 적어 두는 것은 시간이 잘 소요됩니다. 누군가가 나중에 필요할 수도 있고 실제 장기 프로젝트가 아니라면 지나치게 생각하지 않아야합니다.
또한 시간이 걸리지 않아야합니다. 생각하는 데 시간을 투자하면 생각을 1 대 1로 적을 수 있습니다 (사람에게 유용 할 수있는 한).
실제 문제는 당신이 쓰는 것을 지나치게 생각할 수 있습니다. 당신이 글을 쓰고 있다고해서 이미 존재하는 형식을 고수해야하거나 완전한 문서를 작성해야하는 것은 아닙니다.
아무 것도 쓰지 않고 메모장에 비공식 메모를 쓰는 것 중에서 선택하는 경우 비공식 메모를 작성하십시오.