개발자 글쓰기 10가지 원칙

이메일을 비롯해서 회사에서 작성하는 모든 문서는 기술 문서라고 합니다. 기술 문서는 올바르게, 그리고 이해하기 쉽게 전달해야 합니다. 정확하고 잘 읽히며, 유용한 기술 문서를 쓰기 위한 고려 사항 10가지를 소개합니다. 1. 격식을 차린 말투 대신 일상 대화체로 글을 쓴다. 2. 모든 사용자가 제품과 관련 기술을 전문가만큼 잘 아는 게 아니라는 걸 고려한다. 3. 잘못된 단어나 표현으로 정보를 틀리게 전달하지 않았는지 점검한다. 4. 쉽고, 일상에서 쓰는 단어를 사용하여 간결하게 작성한다. 5. 이중 피동 표현을 사용하지 않는다. 예)잡혀지다(→ 잡히다) 6. 매주/매달/매년’ 다음에 '마다'를 붙이지 않는다 7. 국립국어원의 외래어 표기법을 따른다. (컨텐츠 → 콘텐츠) 8. 줄임말을 쓸 때 처음에는 모두 풀어서 표기 Continuous Integration(CI) 하고, 그다음부터는 줄임말만 (CI) 쓴다. 9. 전문 용어를 꼭 써야 하면 그 용어를 설명해 준다. 10 글을 다시 읽어보고, 리뷰를 받는 퇴고 과정을 거친다. 명확한 글쓰기는 다양한 이해관계자들과의 협업을 원활하게 하고 문서의 가치를 높입니다. 보다 더 자세한 내용을 참고하고 싶으신 분들은 링크에 첨부한 사이트를 추천드립니다.

테크니컬 라이팅 깔끔하게 완성하는 10가지 원칙 | DevSecOps 구축 컨설팅, 교육, 기술지원 서비스 제공

InfoGrab Insight

테크니컬 라이팅 깔끔하게 완성하는 10가지 원칙 | DevSecOps 구축 컨설팅, 교육, 기술지원 서비스 제공

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2023년 4월 20일 오전 6:45

 • 

저장 44조회 2,584

댓글 0

    함께 읽은 게시물

    ⟪토스가 만든 리서치툴, TNS⟫

    ... 더 보기

    토스가 특허 낸 리서치툴, TNS (Toss Navigation Score) 제작기

    toss.tech

    토스가 특허 낸 리서치툴, TNS (Toss Navigation Score) 제작기

     • 

    저장 3 • 조회 855


    품질 높은 프로젝트는 어떻게 만들어질까? 🤔

    ... 더 보기

    “품질 높은 프로젝트는 어떻게 만들어질까?”

    F-Lab : 상위 1% 개발자들의 멘토링

    “품질 높은 프로젝트는 어떻게 만들어질까?”

    6년간의 토이프로젝트 여정을 마무리하며 - 기술블로그 구독서비스 회고록

    ... 더 보기

    6년간의 토이프로젝트 여정을 마무리하며 - 기술블로그 구독서비스 회고록

    taetaetae.github.io

    6년간의 토이프로젝트 여정을 마무리하며 - 기술블로그 구독서비스 회고록

     • 

    댓글 2 • 저장 11 • 조회 2,903


    Next.js 앱을 쿠버네티스에 배포하기 (feat. ArgoCD)

    ... 더 보기

    Next.js 앱을 쿠버네티스에 배포하기 (feat. ArgoCD) | 요즘IT

    요즘IT

    Next.js 앱을 쿠버네티스에 배포하기 (feat. ArgoCD) | 요즘IT


    < 좋은 관계를 위한 최소한의 예의, ‘거리 두기’ >

    1. 살다보면 나를 끔찍이 싫어하는 사람이 한둘은 나오게 마련이다.

    ... 더 보기