Adapt a Style Guide
회사나 단체에서는 따로 스타일 가이드를 가지고 있다. 그 가이드에 맞춰서 써라.
Google Developer Documentation Style Guide
Think like your audience
독자의 시각에서 초안을 읽어라.
문서의 목적이 확실한지, 쓰이는 용어와 컨셉이 독자에게 생소하진 않은지 확인하라.
독자의 페르소나(Persona)를 나열해 보아라: 역할, 목적, 지식이나 경험
독자의 페르소나를 생각하면서 초안을 읽어라.
너무 페르소나에 많이 의지하면 문서가 소수에게만 유용할 수 있으니 조심하라.
Read it out loud
초안을 크게 읽으면서 확인하라. 이상한 문구가 있는지, 너무 긴문장은 없는지, 자연스럽지 않은 것은 없는지 확인하라.
직접 읽지 않고 스크린 리더를 사용해서 들어볼 수도 있다.
Come back to it later
초안을 쓴 후 몇 시간 후에 읽어보아라.
Change the context
초안을 종이에 출력해서 읽어보아라.
폰트, 폰트 사이즈, 폰트 색깔을 바꾸어서 읽어보아라.
Find a peer editor
코드 리뷰를 하는 것처럼 문서도 피드백을 줄 사람이 필요하다.
문서의 내용에 관해 전문가일 필요는 없지만 사용중인 스타일 가이드에 익숙한 사람이어야만 한다.