When the Docs Lie

문서화가 유효하지 않을 때의 문제점을 강조하는 글.

이 글은 코드베이스의 문서화가 진정으로 올바르지 않을 때의 위험성을 설명한다. 특히, 구식 문서가 새 기여자들에게 잘못된 확신을 주어 잘못된 작업을 초래할 수 있다는 점을 강조한다. 반면 문서가 전혀 없는 경우는 오히려 더 정직한 불확실성을 초래한다. 따라서 코드베이스의 문서가 항상 유지보수 되어야 한다는 필요성을 강조하고 있다.

The article highlights the dangers of stale documentation in codebases.

This article discusses the risks associated with documentation that is no longer accurate in codebases. It emphasizes how outdated documentation can lead new contributors to operate under false assumptions, resulting in incorrect work. In contrast, having no documentation at all provides a more honest sense of uncertainty. The necessity of maintaining up-to-date documentation to prevent these issues is stressed.