위키 페이지를 잘 만드는 방법에 대한 몇가지 힌트가 있습니다. 이 페이지에 추가하거나 댓글 쓰는 것을 편하게 생각하기 바랍니다.
의미있는 내용으로 최 상단 제목을 정하기 바랍니다.
절(단락) 구별을 위해 빈 행을 사용하기 바랍니다. 평균적인 절(단락)의 크기는 10-20줄을 넘지 않습니다.
만일 문서 내용이 3-5개의 절(단락)보다 길어진다면 2-5단계 제목을 추가해서
섹션들로 분리하는 것을 고려하기 바랍니다.
문서 내용이 2-3 화면 페이지보다 길어진다면 최 상단 제목 다음에 짧은 목차를 추가합니다.
다른 위키 페이지들과 외부 리소스들에 대해 많은 링크들을 가지고 있다면 링크들을 묶어서 참조 섹션을 추가합니다.(
아래 참조).
굵은 글씨 또는 이탤릭 글씨중 선호하는 것을 사용하여 한 단어나 짧은 문구를 강조합니다.
화면 출력, 버튼이나 메뉴 라벨 등의 글씨에 적당한 스타일을 선택해서 일관성 있게 사용해야 합니다. 당신 위키에 대한 관습적인 스타일을 설명하는 페이지를 추가하는 것도 좋은 생각입니다.
서로 관련 없는 글들에 대해서
번호없는 목록을 사용하기 바랍니다. 만일 생각들을 전개해 나가고 있다면 연속적인 문장들을 씁니다.
각주를 남용해서 사용하지 말고 단지 아주 짧은 추가적인 문구만 사용하기 바랍니다. 특정 주제에 대해 쓸 내용이 많은 경우에는
새로운 페이지를 만들기 바랍니다. 만일 다른 (외부) 정보 리소스를 참조하고 싶다면,
링크를 사용합니다.
표(테이블)는 구조화된 자료의 가독성을 크게 증가시킬 수 있습니다. 만일 표를 집어 넣는 경우 내용을 명백하게 알수 있도록 의미있는 행/열, 표 이름이 되도록 합니다. (예. “표 1.2: 별들 간의 평균 거리”).
적절한 문장을 구사하고 필요하다면 명사(noun)들에 대한 기사를 사용합니다.
각 문장은 대문자로 시작해서 마침표나 다른 구두점들로 끝나야 합니다.
너무 많은 종속절에 의지하지 많고 명확하고 짧은 문장들을 써야 합니다. 페이지 작성이 끝났다고 생각될 때 다시 읽고 너무 복잡한 구조를 가진 문장은 고칩니다.
독자들에게 어떻게 말을 걸지 결정합니다. DokuWiki는 주로 문서 작성을 목적으로 하기 때문에 자주 어떻게 일을 해야 할지 명령조로 말을 하게 됩니다. 명령 형태(”Do this!”), 우리는/당신은 형태(“Then we/you click on…”)나 나는 형태(”I then add the foo to bar, using…”)가 가능합니다. 이 어투들을 섞어 쓰지 말기 바랍니다.
문서를 저장하기 전에 비록 좋은 생각일지라도 그 신빙성을 감소시키는 문법이나 맞춤법 오류를 검사를 해야합니다.
자신만의 스타일을 개발합니다. 편하지 않는 방법을 강제로 쓰면 안됩니다. 강제로 쓰게 되면 읽기에 부자연스럽거나 재미없게 보입니다.
더 많은 설명이 필요한 용어를 문서 전체에 걸쳐 쓰게 되면, 용어에 대한
새 위키 페이지를 추가하고 링크를 사용합니다.
문서 편집을 끝내기 전에 페이지를 다시 확인하고 자주 쓴 용어들에 대한 위키 페이지들로 링크들을 추가해야 합니다.
특별한 용어가 나올 때마다 링크를 추가하지 말고, 처음과 가장 잘보이는 곳에서 링크를 만들면 됩니다. 참조 섹션에 대한 링크를 추가해야 할지도 모릅니다.
그림, 자료, 인용구들의 소스에 대한 링크를 제공해야 합니다.
페이지 끝에 ” 참조:“를 추가하는 것을 고려합니다. 작성한 페이지의 주제와 꽤 관계있는 위키 페이지들에 대한 링크를 제공합니다.
문서 주제에 관련 있는 더 많은 정보를 가졌거나 페이지 작성에 사용된 외부 리소스들에 대한 참조 항목들을 가지고 싶다면 참조 섹션을 문서 끝에 추가하고 링크 목록이나 다른 참고 목록들(예. ISBN 번호)을 섹션에 집어 넣습니다. 주 문서 영역에서 언급하지 않았다면 참조 의도를 밝혀야 합니다.
“그림은 수천마디 이상을 말한다.”라는 경구는 원래 의도보다 더 많은 것을 의미합니다. 사람은 말보다 그림에 대해 신뢰도가 높은 경향이 있습니다. 그러나, 짧은 설명은 전혀 설명이 없거나 부정확한 그림보다 낫습니다.
표처럼 그림도 언제나 제목을 쓰도록 합니다. 그림과 함께 보여주고 싶은 것에 대해 말하기 바랍니다.
그림을 직접 만들지 않는 경우에 소스를 언급(가능하면 링크)하고 카피라이트를 표시합니다.
명시적으로 허용되지 않으면 외부 사이트에서 그림에 링크를 걸지 않습니다.이 것은 그림이 있는 사이트로 부터 밴드-위쓰(bandwith)를 낭비하게 됩니다. 가능하다면 그림을 위키로 업로드합니다.
-
이 스타일 가이드에 대한 코멘트, 질문, 제안을 여기에 추가하기 바랍니다. 만일 확신하는 경우 스타일 힌트를 문서에 직접 추가할 수 있습니다.
— ChristopherArndt 2005-09-27 00:44
적절한 네임스페이스 구조를 선택하는 훈련에 흥미를 느낍니까?
english version: dokuwiki-2006-11-06.
Add your email here if you created translated or modified whole or part of this page.
jk Lee - real mail domain is gmail, not zoo.com for spam filtering
2007-2-6 created