본 글은 Technical Writing Process의 5단계를 소개하며, 의사소통을 위한 기술적 글쓰기 방식을 소개합니다. TL;DR What is Technical Writing? : 체계적인 방법으로 글쓰기를 작성하여 글쓰기의 어려움을 없앨 뿐만 아니라, 글의 내용을 정확하고 효과적으로 전달하기 위해 분명하고 알기 쉽게 작성하는 문서 작성 기술. Technical Writing 5 STEP : 기획 > 구조화 > 문서작성 > 리뷰 > 배포 Google의 "Software Engineering at Google" 에서는 Documentation의 중요성을 알리며, 실제 구글러들이 사용하는 방식을 안내합니다. 해당 내용은 Documentation - Software Engineering at Goog..

소프트웨어 엔지니어들은 매일, 그리고 매 번 문서를 포함하여 다양한 글을 작성합니다. 메신저, 이메일, 일일 보고서, 코드, 그리고 심지어 코드 사이의 주석까지 다양한 범주를 아울러 글을 작성합니다. 팀원들과의 원활한 의사소통을 하거나 정보를 나누기 위해서 잘 작성된 문서는 엔지니어들의 업무 환경의 질을 향상시킵니다. 따라서 Technical Writing은 엔지니어링 영역의 중요한 부분 중 하나입니다. 구글은 공학자들의 Technical Writing 능력 향상을 위해서 공식 사이트에서 교육 자료를 공유합니다. 해당 포스팅에서는 구글의 공식 사이트의 한 부분인 Writing Helpful Error Messages를 다룹니다. 해당 포스팅은 오류 메세지를 효율적이고 생산적인 방식으로 작성하는 것을 주로..

본 포스팅은 Software Engineering at Google의 Code Review Flow 내용을 정리한 내용입니다. 해당 내용은 O'reilly에서 출간하고, 저자에 의해 공개된 Software Engineering at Google을 바탕으로 참고하여 정리한 내용입니다. 내용이 재밌기도 하고 기록하고 싶은 내용이 많아서 몇 가지 정리해볼 예정입니다. 테스트와 관련된 참고 내용이 많아서 특히 오래 걸렸네요 ,, 하지만, 그만큼의 가치가 충분한 내용이어서 읽기를 추천드리고 싶습니다 〰️ Unit Testing 탐색적 테스팅 exploratory testing 은 테스트 대상을 고장내야할 퍼즐로 생각한다. 기본적으로 창의력을 요구하는 작업이다. 의외의 데이터를 입력하거나 예상치 못한 절차로 조작..

본 포스팅은 Software Engineering at Google의 Code Review Flow 내용을 정리한 내용입니다. 해당 내용은 O'reilly에서 출간하고, 저자에 의해 공개된 Software Engineering at Google을 바탕으로 참고하여 정리한 내용입니다. 내용이 재밌기도 하고 기록하고 싶은 내용이 많아서 몇 가지 정리해볼 예정입니다. 이번 주제는 문서화에 대한 내용을 다룹니다. 해당 내용은 아주 중요하다고 하기 보다는, 사내 혹은 팀내에 문서화 문화를 정착시킬 때 참고하면 좋을만한 내용이었습니다. 조금 훑어보면 구글은 문서화에 대한 중요성을 느끼고 마치 코드와 같이 관리한다고 합니다. 버전 정보를 관리하고, 리뷰를 받기도 하죠. 대부분의 내용은 개인적으로도 문서화를 할 때나 ..

본 포스팅은 Software Engineering at Google의 Code Review Flow 내용을 정리한 내용입니다. 해당 내용은 O'reilly에서 출간하고, 저자에 의해 공개된 Software Engineering at Google을 바탕으로 참고하여 정리한 내용입니다. 내용이 재밌기도 하고 기록하고 싶은 내용이 많아서 몇 가지 정리해볼 예정입니다. 이번 주제는 코드리뷰와 관련된 내용입니다. 코드 리뷰는 ‘버그가 코드베이스로 침투하기 전에 잡아낸다’처럼 확실하고 쉽게 납득되는 이점을 제공합니다. 구글에서 잘 관리되고 있는 코드리뷰 문화를 알아보고 코드리뷰에 대한 이점과 필요성에 대해 다룹니다. 여기서 주목할만한 단어가 있는데요. 바로 LGTM 입니다. LGTM 란 'looks good to ..

본 포스팅은 Software Engineering at Google의 Leading at Scale 내용을 정리한 내용입니다. 해당 내용은 O'reilly에서 출간하고, 저자에 의해 공개된 Software Engineering at Google을 바탕으로 참고하여 정리한 내용입니다. 내용이 재밌기도 하고 기록하고 싶은 내용이 많아서 몇 가지 정리해볼 예정입니다. 이번 장(chapter 6)의 원래 이름은 Leading at Scale이다. 즉, 규모있는 조직을 이끄는 방식에 대해 다룬다. 결국 누구나 한 팀의 리더가 된다. 이것이 본 장을 정리하려는 이유이다. 필자는 해당 책의 모든 내용을 정리하지 않고, 스스로 판단하기에 오래 보고 싶은 내용들을 정리한다. 본인의 의지와는 상관이 없을 수 있게도 경력이..