문서화가 핵심

모범 사례 2-다음 단계 전에 문서 작성

저는 컴퓨터 및 응용 프로그램의 석사 학위를 받았으며 요구 사항을 완전히 이해하고 문서화하지 않고도 소스 코드를 작성하는 데 열정적이었습니다. 설계 문서 및 테스트 사례 문서는 소프트웨어 개발 수명주기의 어디에도 없었습니다. .... 코딩으로 직접 이동했습니다.

나중 단계에서 나는 큰 문제에 빠졌고 곧 깨달았습니다. Documentation is the Key 성공적인 소프트웨어 개발자, 테스터 또는 설계자가 될 수 있습니다.

작거나 큰 소프트웨어 개발을 시작하기 전에 다음 질문에 대한 답이 있어야합니다.

요구 사항 사양은 어디에 있습니까?
영향 분석 문서는 어디에 있습니까?
디자인 문서는 어디에 있습니까?
모든 가정과 한계를 적절하게 문서화 했습니까?
모든 문서를 검토 했습니까?
모든 이해 관계자의 모든 문서에 서명 했습니까?

위의 모든 질문에 대해 긍정적 인 답변을 얻으면 안전하고 코딩을 진행할 준비가 된 것입니다. 많은 조직이 따라야 할 엄격한 규칙이 있지만 다른 조직에서는 그렇지 않습니다. 모범 사례는 소프트웨어 코딩을 진행하기 전에 필요한 모든 문서를 작성하고 적절한 승인을받는 것입니다.

오늘 배운 것은 내일을 준비합니다!

다시 말하지만, 가능한 한 많은 문서를 보유하는 것이 모범 사례 중 하나입니다. 미래를 준비 할 몇 가지 중요한 문서는 다음과 같습니다.

디자인 접근법
팁과 요령
특수 기능, 명령 및 지침
배운 교훈
특이한 상황
디버깅 방법
모범 사례
앞으로 당신을 도울 수있는 모든 것

문서를 전자적으로 보관하는 것은 비용이 들지 않습니다. 이제 필요한 문서 유지를 시작하겠습니다.