문서에 외부 링크를 추가하는 것은 나쁜 습관입니까?

종종 스택 오버플로에 대한 답변을 찾아서 버그를 해결하고 있습니다. 내가 한 일에 대한 스 니펫을 추가 한 다음 웹에서 기사 또는 페이지에 대한 링크를 추가하는 것은 나쁜 습관입니까?

나는 그것이 나쁜 것으로 생각하지 않지만 외부 링크는 솔루션의 수명주기를 벗어나는 나쁜 습관을 가지고 있습니다. 그렇게 할 때 링크가 더 이상 작동하지 않는 경우 독자에게 도움이되는 충분한 요약을 작성하는 것이 좋습니다.

이것이 바로 회사에 자체 지식 저장소가 있어야하는 이유입니다. 예를 들어, 회사에는 프로젝트 관리, 티켓팅 (버그 및 작업 추적) 및 내가 가장 많이 사용하는 도구 인 Wiki에 사용되는 회사 인 Redmine 이 있습니다. 프로젝트 당 모든 기능 :-)

프로젝트 위키에서 무엇을해야합니까?

• 설명서 링크 : 기능, 기술, 아키텍처, 요구 사항.
• 관련 액터 : 프로젝트 관리자, 개발자, 고객의 주요 계정 관리자, ...
• 환경 별 설명 : 가상 머신, OS, 서버, 구성 ...
• 기타 : 프로젝트 기간 동안 배운 중요 / 흥미로운 것 (프로젝트와 관련된 것).
• 더 많은 페이지.

기타 위키 에 참고 문헌 (링크)을 넣었습니다 . 그러나 내가 믿는 사람들 만 :

• 스택 오버플로 : 긍정적 인 투표와 잘 논쟁
• 소프트웨어 공학 Stackexchange : 긍정적 인 투표와 잘 논쟁
• MKyong.com :이 페이지가 마음에 듭니다 . 정말 유용하고 튜토리얼은 따라 가기가 쉽습니다.
• MDN
• W3C.org
• W3Schools : 문서는 대화 형 (대부분의 경우)이며 사용자 친화적입니다.
• OWASP : 보안 및 취약성 관련 문제 참조
• 공식 웹 페이지 : 때로는 가장 좋은 자습서 나 설명이 공식 웹 페이지에 있습니다.

내 참고 문헌은 내가에 연결하고있는 무슨을 이해했는지 확인하기 위해, 나에 의해 아래로 입력 요약되어 있습니다. Javadoc을 가능한 한 명확하게 유지하려고합니다. 코드의 모든 링크는 Redmine의 Wiki 또는 Redmine의 이슈 코드를 참조합니다.

Redmine과 같은 도구가 없으면 유용한 Markdown 파일이 이러한 목적에 유용 하다는 것을 알았습니다 . 이러한 파일로 인해 개발자에게 전반적으로 SCM에 있으며 코드와 함께 제공됩니다.

인터넷은 사용자가보고있는 내용이 미래의 문서 독자와 동일 할 것이라고 보장하지 않기 때문에 문서에 대한 링크는 다소 문제가 있습니다. 가능하면 변경 가능성이 거의없는 리소스에만 연결하도록 노력하십시오.

예를 들어 Wikipedia에 연결할 때는 일반적인 기사 이름이 아닌 오늘 버전에 명시 적으로 연결해야합니다. stackexchange.com의 경우, 지금은 사라질 것 같지 않지만 질문은 항상 편집되거나 삭제되며 5 년 안에 새로운 모임 장소가 생길 수 있습니다. 조직 외부의 사이트에 상당한 비즈니스 가치를 제공하는 문서를 게시 할 위험이 없습니다.