2024/11/231 구글 엔지니어는 이렇게 일한다 #10장 문서자료를 읽고 #10 문서자료| 일부 내용대부분의 엔지니어가 코드를 작성하고, 이용하고, 유지보수하며 토로하는 대표적인 불만이 양질의 문서자료가 부족하다는 점 입니다. 지금까지의 경험에 한해서는 어디를 가서도 문서자료의 부족함이 없다는 이야기는 못들어 봤다. 항상 문서 자료가 부족하다는 이야기 뿐이었다. | 일부 내용구글에서 문서자료를 개선하고자 해본 시도 중 가장 성공적이었던 방법은 문서자료를 코드처럼 취급하여 엔지니어링 워크플로에 통합하는 것이었습니다. 그 결과 엔지니어들이 간단한 문서자료를 작성하고 유지보수하는 일이 한결 수월해졌습니다. swagger, jsdoc, postman, redoc 등 이를 활용할 수 있는 도구들이 많이 다양해졌다.대다수의 사람들이 최소한 API 명세에 한해서는 문서화의 중요성을 인.. 2024. 11. 23. 이전 1 다음 반응형