목록programming/tips (2)

Jamie the programmer

Docs as Code: API 문서화를 코드처럼 관리하는 방법

API 레퍼런스가 필요한 이유SIGDOC에서 개발자가 새로운 API를 마주했을 때 어떤 행동을 하는지를 주제로 실험을 해 본 결과 API 레퍼런스에 2번째로 가장 많이 시간을 할애한다고 합니다. API 레퍼런스 자동화 기술SwaggerJavadocAsciiDocGoDoc     자동화 기술을 사용하지 않는 이유 FeedbacksAPI 수정할 때마다 컨플문서 수정하기 너무 힘듭니다..문서는 문서대로 테스트는 포스트맨.. 관리 포인트 너무 많아..문서가 너무 무겁.. 경량화 혹은 분할 필요.스웨거, Asciidoc, 컨플루언스.. 통일화 필요!  SSG을 통한 Docs as code정의Docs as code는 기술 문서를 소스 코드처럼 취급하고 관리하는 접근법입니다.Docs like Code로도 불립니다.D..
programming/tips 2025. 3. 1. 18:19
기술 부채 관리를 위한 기술 부채 식별 방법 (feat. Martin Fowler 의 Technical Debt Quadrant)

개요 어떠한 신규 프로젝트를 시작하는데 기술부채를 생산하는 옛날의 범했던 실수를 다시 범하지 않기 위해 기술부채와 관련된 지식을 습득하고 실수를 범하지 않기 위한 좋은 개발 습관을 만들어 나가야 합니다. 기술 부채를 생산하지 않기 위해서 여러 개발 이론 및 기술을 접목하는 것도 중요하지만, 제일 먼저 기술 부채를 식별할 수 있는 사전 지식을 갖추는 게 중요하다고 생각합니다. 해당 글은 Martin Fowler의 기술 부채의 복잡성을 설명하고 구분 방법을 제시하는 기술 부채 사분면(Technical Debt Quardrant) 을 설명하는 글입니다. 기술 부채의 4가지 타입 1. Reckless & Deliberate Debt (신중하지 못했지만, 의도한) 장기간으로 보았을 때 발생할 수 있는 문제를 식별..
programming/tips 2023. 6. 25. 16:40
이전 Prev 1 Next 다음