사용자:DolphinL/프로젝트 작업실

틀은 미디어위키의 매우 강력한 기능 중의 하나입니다. 그러나 틀은 새로온 사용자, 심지어는 숙련된 사용자까지도 그 내용을 이해하고 사용하는데 혼란을 수 있습니다. 따라서 틀은 설명문서를 동반하여 틀에 대한 사용법이 안내되어야 합니다.

틀 설명문서는 틀이 무엇을 하고 어떻게 사용되는지를 설명해주며, 이는 복잡한 틀 문법에 대한 지식이 전혀 없는 사용자조차 틀을 정확하게 사용할 수 있을만큼 명료해야 합니다. 특히, 광범위하게 사용되는 틀일수록 더욱 그러해야합니다.

무엇이 포함되는가

틀 설명문서는 다음을 포함하여야 합니다:

• 기본적인 용도 : 이 틀의 역할이 무엇인지, 또는 이 틀이 왜 필요한지를 설명해주어야 합니다. 비슷한 이름이나 비슷한 목적으로 쓰이는 틀이 있을 경우, 그것을 함께 언급하는 것도 좋은 방법입니다.
• 매개변수 안내 : 매개변수를 어떤 형태로 입력하며, 그것이 어떤 모양으로 출력되는지를 설명합니다.
• 용례 : 입력되는 위키텍스트와 표시되는 화면을