이 문서는 알파위키의 도움말입니다.
이 문서는 알파위키 초보자를 위한 문서로, 규정으로서의 효력을 가지고 있지 않습니다.
이 문서는 알파위키 초보자를 위한 문서로, 규정으로서의 효력을 가지고 있지 않습니다.
1. 개요[편집]
알파위키에서 어떻게 하면 독자가 읽기 좋은 문서를 작성할 수 있는지에 관한 도움말 문서입니다.
위키문법에 관해서는 다루지 않습니다. 해당 내용은 알파위키:문법 도움말을 참고해주세요.
위키문법에 관해서는 다루지 않습니다. 해당 내용은 알파위키:문법 도움말을 참고해주세요.
2. 개요 문단 내용의 적절한 길이[편집]
개요 문단의 설명이 지나치게 간결하거나 지나치게 자세해서는 안 됩니다. 개요 문단의 설명은 문서가 설명하는 대상이 무엇인지에 대해 1~2문장 정도의 설명을 제공하는 것이 좋습니다.
예를 들어, '축구'에 대해 설명한다고 가정해보겠습니다.
축구 문서의 개요 문단의 내용이 아래와 같다면 설명이 너무 짧다고 볼 수 있습니다.
예를 들어, '축구'에 대해 설명한다고 가정해보겠습니다.
축구 문서의 개요 문단의 내용이 아래와 같다면 설명이 너무 짧다고 볼 수 있습니다.
스포츠 종목 중 하나.
'스포츠 종목 중 하나'라는 것만을 설명하며, 축구가 정확히 어떠한 종목인지에 대해 전혀 설명하지 않습니다.
아래와 같은 설명은 지나치게 길 수 있습니다.
축구란, 두 팀의 선수들이 손과 팔을 제외한 다른 신체 부위만을 사용해 상대 골대에 공을 넣어 득점하는 스포츠이다. 경기 시간은 총 90분이며, 전반전 45분과 후반전 45분으로 나뉜다. 전반전/후반전 이후에 심판이 추가 시간을 정해주며, 시간이 끝나더라도 현재 공격 중인 부분을 상대방이 수비하거나 공격이 성공하기 전까지는 경기를 계속 진행한다.
축구 규칙에 대한 설명이 개요 문단에 지나치게 자세히 작성되어 있습니다. 일부 내용은 따로 '규칙'과 같은 문단으로 분리하는 것이 좋습니다.
따라서, 아래와 같이 작성하는 것이 권장됩니다. 아래 설명은 누군가가 축구가 무엇인지를 물어봤을 때 1~2문장 정도의 설명을 제공합니다.
축구란, 두 팀의 선수들이 손과 팔을 제외한 다른 신체 부위만을 사용해 상대 골대에 공을 넣어 득점하는 스포츠이다.
3. 적절한 내용 순서 배치[편집]
독자가 문서를 읽을 때, 내용의 순서가 적절히 배치되어 있어야 합니다.
예를 들어, 특정 버스 노선을 설명하는 문서에서 해당 노선의 문제점을 설명하는 내용이 해당 버스 노선이 경유하는 지역, 노선의 주요 특징에 대한 내용보다 앞에 있다면 그것은 내용의 순서가 적절히 배치되어 있다고 보기 어렵습니다.
독자가 해당 버스 노선을 모르는 상황에서 버스 노선의 경유 지역, 주요 특징을 설명하기도 전에 문제점부터 나열하면 독자가 이해하기 어려운 글이 됩니다.
예를 들어, 특정 버스 노선을 설명하는 문서에서 해당 노선의 문제점을 설명하는 내용이 해당 버스 노선이 경유하는 지역, 노선의 주요 특징에 대한 내용보다 앞에 있다면 그것은 내용의 순서가 적절히 배치되어 있다고 보기 어렵습니다.
독자가 해당 버스 노선을 모르는 상황에서 버스 노선의 경유 지역, 주요 특징을 설명하기도 전에 문제점부터 나열하면 독자가 이해하기 어려운 글이 됩니다.
4. 내용의 자연스러운 연결[편집]
위키의 특성상 타인이 작성한 글에 자신의 글을 추가하는 경우가 많습니다. 이 경우, 두 내용이 자연스럽게 연결되는지를 최종 검토 후 편집을 저장하는 것이 좋습니다.
그러한 부분들을 검토하는 좋은 방법 중 하나는 자신이 문서 내용을 모르는 독자라고 가정하고 처음부터 끝까지 문서를 읽어보는 것입니다.
그러한 부분들을 검토하는 좋은 방법 중 하나는 자신이 문서 내용을 모르는 독자라고 가정하고 처음부터 끝까지 문서를 읽어보는 것입니다.
5. 하나의 문서만으로도 이해 가능[편집]
하나의 문서에 담긴 내용을 이해하기 위해 다른 문서를 추가로 확인해야 하는 경우 좋은 문서라고 보기 어렵습니다.
일부 전문 분야 문서들의 경우, 특정 개념을 설명하는 문서에 전문 용어가 많아서 해당 문서를 이해하기 위해서는 전문 용어들 문서를 추가로 읽어보는 등의 노력이 필요한 경우가 있습니다.
그러한 문서는 독자 입장에서 읽기 좋은 글로 보기 어렵습니다. 가능한 한, 전문 용어의 사용을 피하거나 각주 등으로 전문 용어에 대한 설명을 간단히 작성해두는 것이 좋습니다.
일부 전문 분야 문서들의 경우, 특정 개념을 설명하는 문서에 전문 용어가 많아서 해당 문서를 이해하기 위해서는 전문 용어들 문서를 추가로 읽어보는 등의 노력이 필요한 경우가 있습니다.
그러한 문서는 독자 입장에서 읽기 좋은 글로 보기 어렵습니다. 가능한 한, 전문 용어의 사용을 피하거나 각주 등으로 전문 용어에 대한 설명을 간단히 작성해두는 것이 좋습니다.
6. 이미지와 동영상, 표 활용[편집]
일부 개념들의 경우, 텍스트로 설명하는 것보다 이미지나 동영상, 표를 활용하는 것이 독자가 내용을 이해하기 쉽게 만들 수 있습니다.
예를 들어, 특정 백화점의 내부 구조를 설명하는 문서에서는 텍스트보다는 백화점 측에서 제공하는 실내 지도 이미지 한 장이 더 독자가 내용을 이해하게 쉽도록 도와줄 수 있으며, 이미지가 없는 경우 표 문법을 적절히 활용하여 내부 구조를 적절히 설명할 수 있습니다.
건축학과 등 일부 전문 분야의 지식을 설명할 때는 텍스트로 설명하는 것보다 적절한 유튜브 동영상 등을 인용하여 설명하는 것이 독자가 더 이해하기 쉬울 수 있습니다.
예를 들어, 특정 백화점의 내부 구조를 설명하는 문서에서는 텍스트보다는 백화점 측에서 제공하는 실내 지도 이미지 한 장이 더 독자가 내용을 이해하게 쉽도록 도와줄 수 있으며, 이미지가 없는 경우 표 문법을 적절히 활용하여 내부 구조를 적절히 설명할 수 있습니다.
건축학과 등 일부 전문 분야의 지식을 설명할 때는 텍스트로 설명하는 것보다 적절한 유튜브 동영상 등을 인용하여 설명하는 것이 독자가 더 이해하기 쉬울 수 있습니다.
7. 링크 사용[편집]
적절히 하이퍼링크를 사용하여 다른 문서로 연결하면, 독자가 해당 문서와 관련된 내용을 설명하는 다른 문서들도 확인해볼 수 있게 됩니다.