멋진 안내서 작성 방법

어떤 안내서든 아예 없는 것보다 천 배는 낫습니다. 다음은 규칙이 아닌 지침일 뿐입니다. 저희조차 때로는 이 모든 지침을 따르는 것을 잊거나, 필요할 때 돌아가서 수정하기도 합니다. 저희 모두 사람이기에 실수를 한다는 것을 압니다. 이 안내서들은 시간이 지남에 따라 더 좋아질 것이므로 처음부터 모든 것을 완벽하게 끝내야 한다는 부담을 갖지 마세요. 선구자가 되어 보세요!

훌륭한 사진은 사람들을 수리 안내서로 이끄는 가장 중요한 요소입니다. 저렴한 장비로도 충분히 훌륭한 사진을 찍을 수 있습니다. 촬영 전에 시간을 내어 사진 촬영 튜토리얼을 공부하세요.

사진과 텍스트는 서로를 보완해야 합니다. 추가 사진을 사용하여 텍스트 설명을 보충하거나, 그 반대로 할 수도 있습니다.

"물건", "부품", "것"과 같은 모호한 단어는 수리 안내서를 이해하기 어렵게 만듭니다. 특정 부품의 명칭을 모른다면 Google 검색을 하거나 다른 사람에게 물어보아 최대한 정확하게 식별하세요. 기기 내부에는 복잡한 부품이 여러 개 있을 수 있습니다. 부품을 "이 물건"이라고 부르는 것은 누구에게도 도움이 되지 않습니다!

안내서 전체에서 대상 기기의 방향은 가능한 한 일정하게 유지해야 합니다. 그래야 독자가 자신의 기기에서 현재 위치를 더 쉽게 파악할 수 있습니다. 만약 기기를 회전해야 한다면, "기기를 뒤집으세요" 또는 "기기를 시계 방향으로 90도 회전하세요"와 같이 독자가 따라 할 수 있는 문구를 포함하세요.

약간의 배경 정보는 좋습니다. 왜 이 작업을 하는지, 누가 이 안내서로 혜택을 받는지, 안내서를 준비하기 위해 무엇이 필요한지 등 말이죠. 하지만 거기까지만 하세요. 인터넷의 대다수 사람은 수리하기 전에 책을 읽는다는 생각만 해도 몸서리를 칩니다(TV를 살 때 들어있던 사용 설명서를 마지막으로 읽은 게 언제인가요?).

교차 링크는 좋은 친구입니다. 사이트 내의 관련 리소스에 무엇이든 연결할 수 있는 것은 모두 연결하세요.

증조할머니께서 지갑에 아이스크림을 넣으셨다는 이야기(실화입니다!)도 좋지만, 그런 이야기를 하기에 적절한 상황이 있습니다. 수리 안내서 중간은 그런 곳이 아닙니다.

관련 정보를 더 많이 추가할수록 수리 안내서에 권위가 실립니다.

무슨 말을 하는지 이해할 수 없다면 사람들은 당신의 수리 안내서를 사용하지 않을 것입니다.

글머리 기호를 부적절하게 사용하면 큰 혼란을 초래할 수 있습니다. 시간을 내어 각 글머리 기호의 의미를 읽어본 뒤 사용하세요. 확실하지 않다면 기본값을 사용하세요!

기기가 충분히 간단하다면 재조립 노트가 필요 없을 수도 있습니다. 하지만 재조립 시 특별한 지침이 필요할 수도 있습니다. 예를 들어, MacBook LCD 디스플레이를 분해하는 것은 꽤 간단합니다. 하지만 재조립 과정에서 배선을 제대로 정리하지 않으면 로직 보드의 연결 지점에 닿지 않을 수 있습니다. 독자가 기기를 다시 조립할 때 도움이 될 만한 작은 팁들을 남겨준다면 독자들이 아주 고마워할 것입니다.

경우에 따라 사진과 텍스트만으로는 한계가 있습니다. 도표를 한두 개 추가(사진으로 업로드)하면 독자가 수리 방법을 파악하는 데 확실히 도움이 될 것입니다.

마크업을 너무 많이 추가하면 독자가 사진을 보기 매우 불편해집니다. 마크업이 꼭 필요하다고 생각되는 경우에만, 무엇에 대해 이야기하는지 식별할 수 있을 정도로만 추가하세요. 4~5개 이상의 마크업을 추가하고 있다면, 작업을 여러 단계로 나누는 것을 고려해 보세요. 확실하지 않다면 iFixit 안내서들을 살펴보세요!

안내서 단계 제목은 꼭 필요한 경우에만 사용하세요. 선행 작업 안내서를 올바르게 추가하면 적절한 탐색 구조가 자동으로 생성되므로 대부분의 경우 단계 제목은 불필요합니다.

팀에 "나"라는 글자는 없습니다. 작성할 때도 마찬가지입니다. 안내서에 "내가 이렇게 했다"와 같은 문구를 사용하지 않으면 더 권위 있는 어조를 유지할 수 있습니다.

우리는 서로 수리하는 법을 배우도록 돕기 위해 여기에 있습니다. 정치적 견해나 그와 유사한 의견은 적절한 장소에 남겨두세요.

사용자에게 직접적인 지침을 전달하세요. "~이다/된다"라는 함정에 빠지지 말고, 말하려는 내용을 전달하기 위해 동사를 사용하세요.

직접 소유하고 있거나 권리를 가진 사진과 텍스트만 업로드하세요.