iOS 캠프 TIL - 2021.03.03 수

Closure에서 weak self의 사용

클로저에서 self를 사용한다면 상황에 따라 strong reference cycle 상황이 발생 할 수 있으므로 [weak self] in 을 명시하고, self를 옵셔널로 사용해주자

개발자의 효율적인 문서 작성법 - 이중민

이중민

• IT 개발 서적 기획/편집
• IT 개발 번역(일본어)
• 정확한 사실에 근거한 책을 만들려며 문서를 잘 체계화 할 필요가 있다.

글쓰기 싫어하는 개발자가 있다

• 귀찮다…
• 개발자는 코드로 충분히 이야기할 수 있다고 생각한다
• 빠듯한 일정에 코드 작성하기도 바쁘다

왜 글 쓰기를 해야 할까

• 언제나 검색에 의존할 수 없다. 기록을 남기고 그것을 찾는 것이 빠를 수 있다.
• 사수는 더 바쁜 사람이므로 하나하나 친절하게 알려주지 않는다.
  • 학교가 아니기에 스스로 잘 성장하길 바란다.
  • 질문하지 말고 혼자 해결하라는 것이 아니라, 효율적으로 물어보기위해 글을 잘 써서 정리해서 물어보라는 의미

글 쓰기의 포인트 - 기본 마음가짐

• 개발자는 글 쓰기 전공자가 아니다.
• 개발자는 프로그래밍 ‘언어’를 다루는 사람.
• 문학적인 글을 쓸 필요는 없다.
• 코드의 논리를 그대로 옮기면 좋은 글이다
• 글을 볼 사람의 수준을 고려하면 더 좋다.

글 쓰기의 포인트 - 코드나 명령어 먼저 나열하세요

• 개발 관련 글의 핵심은 보통 코드다.
• 알려주고자 하는 완성된 코드를 먼저 나열해보자
• 코드를 나열할 때는 완성 순서에 맞게 나열한다.
• 보여주고자 하는 예제 코드의 핵심 부분을 중심으로 정리하자
• 핵십 부분 정리가 끝난 상황에서 전체 코드가 길다면 참고 링크로 처리하자
• 기본적인 API 사용법을 설명해야 한다면 해당 부분을 따로 빼서 설명.

글 쓰기의 포인트 - 구조화

• 먼저 전체 주제와 관련된 제목을 정하고 무엇을 설명할 것인지에 관한 요약글을 작성한다. 만약 작성하기 어렵다면 본문부터 작성후 정리해서 작성해도 좋다.
• 코드를 중심으로 주제를 나눈다. 코드에서 설명해야 할 클래스, 메소드, 문법, 예제코드 설명 등을 중심으로 나누면 된다.
• 해당 부분의 연관성을 전제로 설명하는 글을 쓴다.
• 부가저인 설명을 할 때는 표, 목록, 블록 인용문자 등을 활용하자
• 실습형 글 주제는 번호를 붙여서 작성하는 것이 좋다.
• 독자 대상에 따라서 최대한 구체화 하는 것이 좋다.
• 독자 대상이 초보자라면 트러블슈팅 관련 내용을 최대한 챙기는 것이 좋다.

글 쓰기의 본질

• 맞춤법/오탈자? 치명적인 것이 아니면 괜찮다
• 개발자의 효율성도 중요하지만, 글은 여러 사람이 보므로 친절 해질 필요가 있다
• 알아야 할 부분을 정확히 기술하자

블로그 글 쓰기

블로그 글 쓰기의 포인트 1

• 특정 주제를 잡고 연재 형식으로 꾸준히 쓰는 방법
• 내 공부 기록을 꾸준히 남기는 방식
• 누군가에게 보여주는 글인가? 내가 참고하는 글인가?를 미리 생각해두면 좋다.

블로그 글 쓰기의 포인트 2 - 누군가에게 보여주는 글

• 가능하면 경어체로 작성하는 것이 좋다.
• 부연 설명할 다른 사람의 글 또는 내 글을 미리 챙겨두면 좋다
• 특정 주제와 관련해 연재 형색으로 꾸준히 쓰는 방법이 좋다.(검색 최적화에 유리)
• 카테고리 기반으로 정리하면 좋다.

블로그 글 쓰기의 포인트 2 - 나만 보는 글

• 어투는 큰 상관벗다
• 내가 알아볼만한 중요한 포인트를 잡고 쓰는 것이 좋다
• 내 공부 기록을 꾸준히 남기는 방식이 좋다
• 태그 기반으로 정리하는 것이 좋다.

블로그 플랫폼을 선택할 때 고려할 점

• 본인이 운영하기 편한 블로그를 선택하면 된다.
• 특별하 생각한 것이 없다면 다음 세가지 고려
  • 지킬 기반 깃허브 블로그
  • 벨로그
  • 노션
  • 선정 기준은 마크다운 지원 여부