테크니컬 라이팅 깔끔하게 완성하는 원칙
(insight.infograb.net)1.지나치게 격식을 차린 말투 대신 일상 대화체로 씁니다
2.글을 소리 내 읽고, '실제 사람이 하는 말로 들리는지' 점검합니다.
3.사용자 관심사, 특성, 교육·경험 수준, 글 읽는 시간·장소, 업무환경을 염두에 둡니다.
4.사용자가 궁금해할 만한 정보, 사용자에게 필요한 정보를 선택해서 제공합니다.
5.모든 사용자가 제품과 관련 기술을 전문가만큼 잘 아는 게 아니라는 걸 고려합니다.
6.글을 발행한 뒤에도 용어, 사용법, 기능 변경 사항을 제때 반영합니다.
7.불필요한 수식어, 조사(~을/~를), 보조용언(~고 있다)을 사용하지 않습니다.
8.이중 피동 표현을 사용하지 않습니다.
예)잡혀지다(→ 잡히다), 쓰여지다(→ 쓰이다), 읽혀지다(→ 읽히다), 보여지다(→ 보이다), 잊혀지다(→ 잊히다), 찢겨지다(→ 찢기다)
9.'여러/많은/다양한/모든' 다음에 오는 단어에 '~들'을 붙이지 않습니다.
10.전문 용어를 꼭 써야 하면 글에서 그 용어를 설명해줍니다.
11.특정 산업이나 직종 관계자를 상대로 글을 쓸 때, 해당 산업 또는 직종 관련 용어를 사용합니다.
12.글을 완성하고 휴식을 취한 뒤, 이를 다시 읽어봅니다.
13.데스크톱으로 글을 작성했으면 스마트폰이나 태블릿 PC로 글을 읽습니다. 글을 출력해서 읽어도 좋습니다.
14.글을 소리 내 읽고, 어떻게 들리는지 확인합니다.
15.말하기 불편하거나 어색하게 들리는 문장을 고칩니다.
16.리뷰어에게 '글 내용이 잘 이해되는지', '글 흐름이 괜찮은지', '추가할 내용은 없는지' 등을 묻습니다. 피드백이 필요한 내용을 구체적으로 질문해도 좋습니다.
17.특정 기능을 글에서 다뤘다면 '이 기능이 글 내용대로 작동하는지' 테스트합니다.
18.'기능·메뉴 이름이나 화면 내용이 글 내용과 같은지' 확인합니다.
19.맞춤법 검사기로 오탈자, 띄어쓰기 오류를 확인합니다.
추천 도구: 부산대 맞춤법 검사기, 다음 맞춤법 검사기
20.국립국어원 외래어 표기법 용례를 보고, 외래어 표기 오류를 확인합니다.
외래어 표기 오류가 진짜 문제가 좀 많은게,,
메서드, 엔젤 이런 것들이 메소드, 에인절 이렇게 적어야하는 것들이 많습니다.
문제는 "잘못된 표기법"이 더 많이 사용되고 심지어 SEO도 잘되어있는.. 말도 안되는 상황이 있다는 것이죠.
무엇이 정답일지요..? ㅠㅠㅠ
올바른 거는 각각 "메서드" "에인절"(Angel)로 나오네요.
이 밖에도 객체의 경우 MS에서는 "개체"라고 순화하고 있기도 하고..
참 테크니컬 라이팅이 정말 어렵습니다.