본문 바로가기

테크니컬라이팅5

이원석의 TDDing - 객체지향 생활 체조 원칙 보호되어 있는 글 입니다. 2024. 11. 17.
글쓰기 가이드 요약 보호되어 있는 글 입니다. 2024. 11. 17.
비기닝 오브 크래프터스 보호되어 있는 글 입니다. 2024. 8. 30.
4장 초안 작성 6. 일단 쓴다.처음부터 완벽하게 쓰려 하지말고 일단 쓰고 싶은 내용을 전부 쓴다. 쓰다보면 정리 및 추가할 내용 생각이 날 수도 있기 때문이다.준비단계에서 정한 독자를 떠올리며 독자가 궁금해할 내용, 전달해야 할 내용을 빠짐없이 추가하는 데에만 집중한다.글을 다듬는 일은 그다음에 생각한다.  7. 명확성, 간결성, 일관성의 3원칙명확성다루는 내용이 정확하고 전달하는 방식과 표현이 선명하도록 하자.단정적이지 않은 표현,추측성 표현은 사실전달이 목적인 기술문서에서는 신뢰를 주기가 어렵다.간결성짧고 쉽게 쓰도록 신경 쓰자.단락을 5개 안팎 문장으로 구성하면 좋다.일관성문서 전체에서 설명하는 내용이 일관되게 하자.앞뒤 내용, 같은 의미의 용어나 설명방법 8. 핵심부터 쓴다.기술문서는 정확한 내용의 빠른 전달이.. 2024. 8. 18.
개발자를 위한 글쓰기 가이드 3장 1. 대상 독자 정하기독자를 정하는 것이 중요하다. 그이유는 내용 깊이 조절, 전문용어 사용범위, 어조를 정할 수 있기 때문이다. 독자 선정 방법직무를 고려하여 나눈다. ( 개발자, 비개발 업무자 등등..)구체적인 기술 수준을 고려한다. 체크리스트더보기항목확인독자가 원하는 것은?문제 해결 사례를 통해 같은 문제 시간 단축?인사이트, 실무에 적용 가능한 부분독자가 이문서를 보고 무엇을 할 것인가?실무에 적용하는 걸 하려고 하지 않을까? 아니면 지식의 확장? 독자의 기술 수준은? 독자가 이미 알고 있는 정보는?다 섞여 있어서.. B2B기준 개발이나 운영쪽이면 기본 cs적인 부분, 그리고 springboot쪽 정도?어떤 직업, 어떤 직위에 있는 사람?개발자, 기획자, 운영, QA등등독자의 학력,전문용어 이해수.. 2024. 8. 17.