넷마블 테크니컬 라이터로 일한 8개월의 회고 | 요즘IT
요즘IT
테크니컬 라이터가 알려주는 글쓰기 팁
요즘은 테크니컬 라이터 분들이 기술 블로그를 관리하시기도 하는군요!
넷마블의 기술블로그를 담당하는 테크니컬 라이터의 회고록을 보면서, 개발자의 글쓰기에 관한 인사이트를 얻을 수 있었습니다.
좋은 개발 문서를 작성하려면 어떻게 해야할지 그 노하우가 담긴 글인데요. 개인 기술 블로그를 운영하거나, 회사에서 기술 문서를 작성할 때 꼭 참고해보면 좋은 팁인것 같아 정리해봤습니다.
✍🏻 기술 문서 작성하기 팁
• 개발 문서를 보는 대상에게 가장 익숙한 용어로 통일하는 것을 권장.
• 샘플 코드나 명령어 등은 영어 그대로 작성한다.
• 알파벳 철자가 많은 영단어는 한글로 음차해서 표현한다. (ex. StackOverFlow = 스택오버플로우)
• 외래어 표기법이 헷갈릴 때는 표준국어대사전과 우리말샘에서 확인하기!
• 무엇을 쓸지 키워드나 제목을 나열해 목차(ToC)를 만들어볼 것
• 예제나 샘플 코드를 먼저 정리하고 작성하기
• 명령어 기반 가이드는 명령어와 결과를 정리하면 좋다.
• 원인과 결과 관계가 맞는 논리적인 글로 작성하도록 노력한다.
• 퇴고 (글쓰기의 QA 과정)
👩🏻💻 좋은 문서 작성 도구 기준
• 내가 글쓰기 편한 도구
• 웹페이지 변환에 용이하도록 HTML, 마크다운으로 내보내기 가능한 도구
• 버전 관리가 가능한 도구
• 글쓴이의 톱 픽 👉🏻 Visual Studio Code
다음 내용이 궁금하다면?
이미 회원이신가요?
2023년 5월 3일 오전 10:13
댓글 0
함께 읽은 게시물
내가 진심으로 창업가이자 사업가로 리스펙트하고 사업피봇팅시 직접 엔젤투자를 한 홀릭스 박태영 대표가 동국대학교 캠퍼스타운이 IT동아와 함께 ‘2025년 스케일업 프로그램’에서 우리 회사가 사업 분석 컨설팅을 맡았던 포플러플래닛의 전문가 컨설팅을 맡아 진행했다. 포플러플래닛 대표님께 많은 도움이 되었을거라 믿는다.
... 더 보기![[스케일업] 포플러플래닛 [1] 홀릭스 “큰 시장만 좇지 말고 브랜드 강점 내세워 돌파해야”](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)
“왜 나는 욱하고 말았을까?” “왜 나는 그렇게 화를 분출했을까?” 회의 중, 메신저에서, 피드백을 주고받을 때 리더의 감정 폭발은 일순간에 리더십 전체를 흔들어놓는다. 그리고 회의가 끝나고 긴장이 풀리면 리더는 ‘지적의 정당성’과는 별개로 자신의 감정적 태도를 후회하고 자책한다.
... 더 보기회사 때려치고 사업이나 한번 해볼까?
회
... 더 보기⟪토스가 만든 리서치툴, TNS⟫
토
... 더 보기미들캡 딜 가격에도 영향을 미치고 있다. 준오헤어의 초기 매각가는 5000억원대로 거론됐다가 현재 8000억원대로 치솟았다. 블랙스톤 KKR 칼라일 등 글로벌 대형 PEF들이 관심을 보이면서 몸값이 올랐다는 게 업계의 후문이다. 한 IB 업계 관계자는 “글로벌 PEF들이 과거에는 조 단위 이상 대형 딜에만 집중했지만 최근에는 투자집행이 중요한 만큼 1조원 안팎의 거래라도 성장성이나 시너지가 있다고 판단되면 적극적으로 들여다보는 분위기”라고 전했다.
... 더 보기미 육군 리더십센터는 리더십, 조직심리학, 인지과학 분야에서 세계 유수 연구기관과 어깨를 나란히 하는 곳이다. 특히 불확실한 상황하에서의 의사결정, 위기 관리 분야를 선도하고 있다. 미 육군 리더십센터의 연구성과 중에서 주목할 만한 것은 ‘독성 리더십(Toxic Leadership)’에 관한 것이다.
... 더 보기
