글쓰기 (2) 썸네일형 리스트형 11 Ways to Write Better We are all writers now. Whether you write books, blog posts, emails, Instagram captions, or text messages, you are a writer. No matter your preferred medium, here are a few tips to help you write more effectively. Treat text messages like prose. Before hitting the send button, review your text: spelling, content, punctuation. Ask yourself: What am I attempting to communicate? What am I attemptin.. 문서 작성 가이드라인 안녕하세요 :) 테크니컬 라이터 Sunny입니다. 오늘은 개발자분들이 문서를 작성할 때 참고할만한 가이드라인을 공유합니다. 기본적인 것들이지만 이것만 고쳐도 글이 깔끔해질거에요 ㅎㅎ 도움이 되길 바랍니다 ^.^ 목차 구성 기본 구조 크게 3단계로 이뤄집니다. what (무엇), why (왜), how (어떻게) 이 기능이 무엇인지? 용어 정의를 포함합니다. 이 기능을 왜 써야 하는지?어느 상황에서 사용하면 유용한지 얘기합니다. 이 기능을 사용하면 사용자에게 주는 이익이 무엇인지 구체적으로 설명합니다. 이 기능을 어떻게 쓰는 건지? 목차 구성이 힘드시면 테크니컬 라이터와 함께 고민하셔도 좋습니다 :) 개념 설명 어려운 개념은 비유와 예시를 적절히 들어서 이해를 돕습니다. 간결한 문장 한 문장이 최대 2줄을.. 이전 1 다음