egg.dev.log

🐾들어가며Docs for Developers 의 chapter5 샘플 코드 통합하기를 읽고 정리했습니다. 이번 챕터에서는 샘플 코드의 유형 별로 작성하는 원칙에 대해 다루며, 유용한 샘플 코드를 설계하는 것을 목표로 하고 있습니다. ✨본격적으로✅샘플 코드 유형- 실행 가능형: 필요에 따라 일부 수정하여 사용할 수 있는 바로 실행이 가능한 형태 - 설명형: 뭔가 배우거나 자신의 코드와 비교하고자 사용하는 출력 결과나 코드 블록 ex) API 문서 이번에는 vue js 공식문서를 예시로 들었습니다! 아래는 순서대로 실행 가능형 코드와 설명형 코드입니다. ✅좋은 샘플 코드의 원칙독자는 샘플 코드가 그냥 잘 작동하기를 기대하비다. 독자는 문서를 훑어보고, 샘플 코드를 찾고, 샘플 코드에서 나타나는 개념을 파악하..

🐾들어가며 Docs for Developers 의 chapter4 문서 편집하기를 읽고 정리했습니다. 이번 챕터에서는 문서 작성과 문서 검토를 분리하여 창작과 평가 과정을 분리하는 편집 프로세스를 만드는 것을 목표로 합니다. ✨본격적으로 ✅편집에 대한 접근법 편집 단계에서 중점을 두어야 할 것은 다음의 4가지로, 각 단계마다 하나씩 점검해야 합니다. 한 번에 많이 하는 경우, 속도가 현저히 느려질 수 있기 때문입니다. 기술적 정확성 완전성 구조 명확성과 간결성 기술적 정확성을 위한 편집 누군가가 이 지시 사항을 따라가면 약속한 결과를 얻을 수 있는가? 혼동을 일으킬 수 있는 기술적인 은어나 용어가 있는가? 코드의 함수, 파라미터, 엔드포인트가 올바르게 명명되고 설명되었는가? 완전성을 위한 편집 [TODO..

이전글 보러가기 >> 2024.01.14 - [Read] - 기술 문서 작성을 위한 문서 유형 🐾들어가며 Docs for Developers 의 chapter 3 문서 초안 만들기를 읽고 정리하였습니다. 다루는 주제는 아래와 같습니다. 도구 선택 개요 작성 초안 작성 초안을 작성할 때 작성이 막혔을 때 템플릿으로 작성하기 책에서는 순서를 부여하지 않았지만, 저는 단계별로 있는 게 이해하기 쉬워서 순서 목록으로 작성했습니다! 그러다보니 리스트 형태로 정리했는데, 각 단계별로 생각할 점을 체크 리스트로 만들어 보는 것도 좋을 듯 합니다. 읽은 내용을 정리하는 것이기에 최대한 사견을 빼고, 제 것으로 만들기 위해 이해한 대로 순서를 재배치하면서 정리했습니다. 평소 생각하지 못했던 것들은 인용구로 강조하여 적었..

🐾들어가며 Docs for Developers 의 chapter 2 문서화 계획하기를 읽고 예시를 찾아보면서 같이 정리했습니다. 이번 챕터에서는 각 문서의 종류와 문서를 작성하기 위한 포괄적인 계획을 세워보는 것을 목표로 합니다. ✨본격적으로 ✅문서의 유형 코드 주석, 리드미, 시작하기, 개념, 절차, 참조 문서 문서의 종류는 위와 같이 6가지로 소개하고 있습니다. 그 중 개발 문서라고 하면 흔히 생각나는 API와 RELEASE NOTE 등은 REFERENCE 유형입니다. ✅각 문서의 특징과 예시 이제 유형을 하나씩 보면서 어떤 특징이 있는지 등에 대해 정리해보겠습니다. 또한, 그동안 공식 문서들을 읽을 때 대부분 비슷한 형태로 쓰여져 있는지 알 듯 합니다. 그래서 예시를 좀 찾아보면서 비교해보려고 합니..