위키백과:기술 문서를 이해할 수 있도록 만들기

Wikipedia
"WP:TECHICAL"은 여기로 리디렉션됩니다.기술적인 질문과 제안은 위키백과를 참조하십시오.마을 펌프(기술).기사 제목에 대한 기술적 제한은 위키백과를 참조하십시오.명명 규칙(기술적 제한).기술적인 움직임에 대해서는 위키백과를 참조하십시오.요청된 이동/기술 요청입니다.
위키백과 지침
행동학
토론
토론 도구
내용물
편집
조직
스타일.
삭제
프로젝트내용
다른.

위키백과의 기사 내용은 가능한 한 광범위한 일반 독자를 위해 작성되어야 합니다.

내용을 추가하고 새로운 기사를 작성할 때는 형식적인 어조의 백과사전 스타일이 중요합니다.위키피디아의 글은 에세이적이거나 논쟁적이거나 의견을 제시하는 글 대신에 직설적이고 사실에 입각한 글을 써야 합니다.모든 합리적인 시도는 가능한 한 광범위하게 이해할 수 있는 방식으로 자료가 제시되도록 해야 합니다.기사가 매우 기술적인 방식으로 작성되었지만, 그 자료가 더 이해하기 쉬운 설명을 허용한다면, 편집자들은 그것을 다시 쓰는 것을 강력히 권장합니다.

청중

위키백과에는 세 가지 방법으로 등급을 매길 수 있는 다양한 청중이 있습니다.

  • 그 주제에 익숙할 때.
    • 일반 독자들은 주제 분야에 대한 고급 교육을 받지 못했고, 주제 자체에 대해 많이 알지 못했으며, 주제가 무엇인지조차 잘 모를 수 있습니다.
    • 지식이 풍부한 독자는 주제 분야의 교육을 받지만 주제 자체에 대해 배우고 싶어합니다.
    • 전문가 독자는 주제를 알고 있지만 더 많은 것을 배우거나 어떤 사실에 대해 상기되기를 원하거나 위키백과의 적용 범위에 대해 궁금해합니다.
  • 읽기 능력에 관하여.다양한 무료 온라인 도구는 자동으로 텍스트의 가독성을 평가하거나 http://www.hemingwayapp.com (가독성 지수) 또는 http://www.readabilityofwikipedia.com (가독성)와 같은 복잡한 문장 구조를 강조할 수 있습니다.
  • 주제에 대해 배우려는 동기 부여.

높은 교육을 받고, 지식이 풍부하고, 동기부여가 되는 독자는 5,000단어짜리 특집 기사를 끝까지 편안하게 읽을 수 있습니다.다른 독자는 그림을 보면서 어려움을 겪을 수도 있습니다.좋은 기사는 모든 독자들의 흥미를 사로잡을 것이고 그들이 할 수 있고 동기부여가 되는 만큼 그 주제에 대해 배울 수 있게 해줄 것입니다.기사는 독자의 읽기 능력보다 훨씬 높은 수준으로 쓰여지거나, 독자가 주제나 분야에 익숙하다고 잘못 가정하거나, 주제를 너무 기본적인 수준으로 다루거나, 포괄적이지 않기 때문에 실망스러울 수 있습니다.

모든 청중 그룹의 구성원이 우연히 기사를 발견하고 기사를 읽기로 결정할 수도 있습니다(예: Special:무작위), 일부 주제는 자연스럽게 더 제한된 청중을 끌어들입니다.연구되거나 토론되기 전에 수년간의 전문가 교육이나 훈련이 필요한 주제는 일반적으로 청중이 더 제한적일 가능성이 높습니다.예를 들어, 고급 수학, 전문가 법, 또는 산업 공학의 주제는 지식이 풍부한 독자들만이 이해하거나 이해할 수 있는 자료를 포함할 수 있습니다.반면에, 학문적으로 진보된 수준에서 공부한 많은 과목들은 더 많은 청중들에게 흥미로운 것으로 남아있습니다.예를 들어, 태양은 천문학자들 이상의 관심사이고, 알츠하이머병은 의사들 이상의 관심사가 될 것입니다.

대부분의 위키백과 기사들은 평균적인 읽기 능력과 동기부여로 일반 독자들이 충분히 이해할 수 있도록 작성될 수 있습니다.어떤 기사들은 본질적으로 기술적이고 어떤 기사들은 기술적인 부분이나 측면을 가지고 있습니다.이들 중 많은 것들은 여전히 많은 청중들이 이해할 수 있도록 쓰여질 수 있습니다.일부 주제는 본질적으로 복잡하거나 전문 교육 또는 훈련을 통해 얻은 많은 사전 지식을 필요로 합니다.그러한 주제에 대한 포괄적인 기사가 모든 독자들이 이해할 수 있기를 기대하는 것은 불합리합니다.특히 리드 섹션에 중점을 두고 가능한 한 많은 사람이 기사를 이해할 수 있도록 노력해야 합니다.기사는 비전문가가 제대로 이해할 수 있는 간단한 영어로 작성되어야 합니다.

기술 콘텐츠 지원

지름길

위키백과는 진지한 참고 자료가 되기 위해 노력하고 있으며, 고도로 기술적인 주제는 여전히 일부 위키백과 기사에 포함되어 있습니다.기술적 내용의 이해도를 높이는 것은 지식이 부족한 독자들을 위해 기사를 개선하기 위한 것이지만, 이는 더 기술적인 배경을 가진 독자들에게 가치를 감소시키지 않고 이루어져야 합니다.

기사를 더 이해하기 쉽게 만든다고 해서 세부적인 기술 내용이 제거되어야 하는 것은 아닙니다.예를 들어, 어떤 화합물에 대한 백과사전 기사는 일반 독자들이 그 특성 중 일부를 잘 알지 못하더라도 그 화합물의 특성을 포함할 것으로 예상됩니다.그러나 고도로 기술적인 세부 사항을 요약하면 일반 독자와 전문가 모두 텍스트의 가독성을 향상시킬 수 있습니다.예를 들어, 어떤 결과에 대한 장황한 수학적 증명은 일반 독자나 전문가가 읽을 것 같지 않지만, 증명의 짧은 요약과 가장 중요한 요점은 전문가 독자에게 유용성을 줄이지 않고 일반 독자에게 의미를 전달할 수 있습니다.어느 정도의 기술적 세부 사항을 포함하는 것이 적절한지 결정할 때, 기사의 주제가 속하는 특정 기술 분야의 표준 참조 작업과 비교하는 것이 도움이 될 수 있습니다.

리드 섹션

추가 정보:위키백과:스타일 설명서(리드 섹션) ① 소개문
지름길

첫 번째 섹션(목차 위의 "리드" 섹션)은 광범위한 독자들이 이해할 수 있도록 하는 것이 특히 중요합니다.독자들은 이미 주제를 자세히 알지 못하더라도 기사가 무엇에 관한 것인지, 올바른 기사를 읽고 있는지 알 수 있어야 합니다.요약이나 일반적인 정의만을 찾고 있는 사람은 리드 끝에서 읽기를 멈출 수 있습니다.이해할 수 있는 단서는 독자들이 기사 본문을 계속 읽도록 장려합니다.

이러한 이유로 리드는 기사에 대한 이해할 수 있는 개요를 제공해야 합니다.리드는 어떤 식으로든 주제의 모든 주요 측면을 언급하기 위한 것이지만, 리드에 주제를 요약하고 기술적 세부 정보를 기사 본문에 배치하는 것만으로 접근성을 개선할 수 있습니다.기사의 리드는 일반 독자들에게 주제의 연구 분야, 주제가 그 연구 분야에서 차지하는 위치, 주제가 무엇에 적합한지, 기사를 이해하기 위해 무엇을 먼저 배워야 하는지를 알려주어야 합니다.

일반적으로 리드는 독자가 기사의 주제에 대해 잘 알고 있다고 가정해서는 안 됩니다.리드 섹션의 용어는 기사를 적절히 요약하고 다른 기사에 대한 링크에 의존하지 않는 방식으로 수행될 수 있을 때마다 일반 독자가 직접 이해할 수 있어야 합니다.다른 기사에 대한 링크는 추가 정보를 제공하기 위한 보충 자료가 되어야 하며, 가급적 먼저 텍스트를 이해하는 데 필요하지 않아야 합니다.일반 청중에게 친숙한 용어로 개요를 제공하기 어려운 고도로 전문화된 주제의 경우, 사전 지식을 이해하는 데 필요한 전제 조건과 연결하면서 일부 배경 지식을 미리 가정하는 것이 합리적일 수 있습니다.

경험칙

다음은 적당히 또는 고도로 기술적인 주제를 다루기 위한 몇 가지 아이디어입니다.

기사의 가장 잘 알려지지 않은 부분을 앞에 놓습니다.

지름길

나중에 필요할 경우 더 기술적인 부분을 사용해도 괜찮습니다.세부적인 것에 관심이 없는 사람들은 그저 어느 순간에 읽기를 멈출 것이고, 그렇기 때문에 그들이 관심 있는 자료가 우선적으로 필요한 것입니다.기사의 링크된 섹션은 기사의 첫 번째, 쉬운 단락이 기사 중간의 섹션에 연결되면 연결된 섹션의 첫 번째 부분도 이해할 수 있도록 유사한 기술 수준에서 시작하는 것이 이상적입니다.또한, 더 기술적인 섹션은 세부사항으로 들어가기 전에 첫 번째 단락의 주요 아이디어를 요약하여 개선할 수 있습니다.

순환적인 설명을 피하십시오. A를 B로, B를 A로 정의하지 마십시오.기술 용어가 정의되기 전에 사용되지 않는지 확인합니다.

한 단계 아래로 쓰기

지름길

접근성을 높이기 위한 일반적인 기술은 주제가 연구되는 일반적인 수준(예: 보조, 학부 또는 대학원)을 고려하고 이전 수준의 독자를 위해 기사를 작성하는 것입니다.따라서 학부 주제에 대한 기사는 중등학교 배경을 가진 독자를 대상으로 할 수 있고, 대학원 주제에 대한 기사는 일부 학부 배경을 가진 독자를 대상으로 할 수 있습니다.리드 섹션은 특히 이해할 수 있어야 하지만 한 단계 아래로 적으라는 조언이 기사 전체에 적용되어 전체적인 접근성을 높일 수 있습니다.한 단계 아래로 쓰는 것은 또한 독자들이 주제에 대한 다른 출처를 읽기 시작하기 전에 사용할 수 있는 3차 출처를 제공하는 우리의 목표를 뒷받침합니다.

구체적인 예를 추가합니다.

많은 기술 기사들은 추상적이기 때문에 이해할 수 없고 전문가 독자들에게도 더 혼란스럽습니다.구체적인 예는 많은 독자들이 추상적인 내용을 문맥에 넣을 수 있도록 도와줄 수 있습니다.때로는 대조적인 예(반례)도 도움이 될 수 있습니다.예를 들어, 기사 동사에서:

라틴어 동사는 문법적으로 어떤 행동(끌어오기, 읽기, 걷기, 달리기, 배우기), 발생(일어나기, 되기, 또는 존재하기, 서기)을 전달하는 단어입니다.

예제는 다른 내용이 적용되는 원래 연구가 없다는 동일한 요구사항을 충족해야 합니다.

공식을 영어로 설명합니다.

가능하다면, 전문가들에게도 공식이 왜 특정한 특징을 가지고 있거나 특정한 방식으로 쓰여졌는지 영어로 설명하는 것이 도움이 될 수 있습니다.공식의 "의미"를 설명하는 것은 독자들이 따를 수 있도록 도와줍니다.최소한 수식의 모든 변수가 문서에 정의되어 있는지 확인하거나 이를 설명하는 문서에 대한 링크가 있어야 합니다.

사진 추가

추가 정보:위키백과:그래프

시각적 묘사는 많은 사람들이 더 효과적으로 학습할 수 있도록 하며, 기술적 개념을 보다 간결하고 명확한 방식으로 전달할 수 있도록 합니다.다이어그램은 해당하는 경우 기호 또는 구두 설명과 관련되어야 합니다.유용할 수 있는 몇 가지 템플릿:

  • {{Location map}}지도/이미지 위에 하나의 이미지 표시 + 레이블을 오버레이합니다.
  • {{Location map many}}지도/이미지에 많은 이미지 표시 + 레이블을 오버레이합니다(최대 9개의 마커);
  • Module:Location map/data/100x100모든 이미지에 대해 100x100 오버레이 그리드의 예가 있습니다.
  • {{Superimpose}}열려 있는 다이어그램과 같이 경계가 없는 이미지에 오버레이합니다.

지나치게 전문적인 언어 사용 방지

주요 지침:위키백과의 기술 언어:스타일 설명서

  • 전문 용어와 두문자어를 현명하게 사용합니다.기술 용어를 설명하고 처음 사용할 때 약어를 확장합니다.또한 이후에는 사용을 자제하거나 아예 사용하지 않는 것을 고려할 수 있습니다.특히 한꺼번에 도입되는 새로운 용어가 많은 경우, 더 친숙한 영어 단어를 대체하는 것이 혼란을 줄이는 데 도움이 될 수 있습니다(정확성이 희생되지 않는 한).
  • 정밀도가 손실되지 않으면 전문 용어 대신 일반 용어를 사용합니다.기술 용어가 완전히 동일한 경우 일반 용어로 대체합니다.
  • 설명문 앞에 경고문을 붙이는 것을 고려해 보세요.명확성을 개선하기 위해 덜 완전하거나 정확한 설명이 제공될 경우, 다음과 같은 문구로 서문을 작성합니다.아니면 "몇 가지 예외를 제외하고는..그래서 독자들은 설명 뒤에 더 복잡함이 있다는 것을 알고 있습니다.간략한 설명문을 따라 자세히 설명하거나 "강력한 정의" 섹션을 포함하여 전체적으로 기사가 완전하고 정확하도록 하십시오.
  • 긴 형용사 줄, 특히 기술 형용사 줄을 제거합니다.
  • 가능하면 짧은 문장을 사용하세요.문장 길이가 12단어를 초과하면 이해력이 급격히 떨어집니다.그러나 짧은 문장을 연속으로 너무 많이 사용하면 단조로워집니다. 독자의 흥미를 유지하기 위해 문장 길이를 변경합니다.
  • 가독성을 높이기 위해 동사를 더 많이 사용합니다. – 많은 기술적 형용사를 동사로 대체할 수 있습니다.
  • 대화에서 사용하는 것과 유사한 언어를 사용합니다.많은 사람들이 기사를 쓰고 회의에서 말할 때 더 많은 기술적인 언어를 사용하지만, 대화에서 더 이해할 수 있는 산문을 사용하려고 노력합니다.
  • 일상적인 용어로 주제를 설명하려면 유추를 사용합니다.멀리 떨어져 있는 유사성을 피합니다.최고의 유추는 이해력과 완전한 이해력 사이의 모든 차이를 만들 수 있습니다.하지만, 위키백과는 교과서가 아니기 때문에 비유는 백과사전적인 방식으로 작성되어야 하며 신뢰할 수 있는 출처에 기인해야 합니다.구체적인 출처가 없는 광범위한 설명은 독창적인 연구 또는 합성에 의한 독창적인 연구를 구성할 수 있습니다.

너무 단순화하지 않음

지름길

더 이해하기 쉽게 하기 위해 자료를 지나치게 단순화하지 않는 것이 중요합니다.백과사전 기사는 독자들에게 그들이 이해하지 못했을 때 그들이 무언가를 이해한다는 느낌으로 쉽게 가는 길을 제공한다는 의미에서 "아이들에게 거짓말을 해서는" 안 됩니다.

너무 기술적인 기사에 레이블 지정

합의된 이해 기준을 충족하지 못하는 기사에 레이블을 지정하기 위해 다양한 템플릿을 사용할 수 있습니다.

충분히 이해할 수 없는 기사에 대해서는,{{Technical}}템플릿은 해당 토론 페이지의 맨 위에 삽입해야 합니다.당신은 왜 그것이 너무 기술적이라고 생각하는지에 대한 설명이나 개선을 위한 제안을 토크 페이지에 넣어야 합니다.설명 없이 추가된 템플릿은 무시되거나 제거될 수 있습니다.이 템플릿이 포함된 문서는 다음 범주에서 찾을 수 있습니다.너무 기술적인 위키백과 기사.

이 태그는 위에 나열된 지침에 따라 누군가가 개선할 수 있다고 생각하는 기사에만 사용해야 합니다.

"소개...물품

불가피하게 기술적이지만 동시에 비기술적 독자에게 중요한 관심사인 주제의 경우, 하나의 솔루션이 별도의 소개 기사가 될 수 있습니다.예를 들어 바이러스 소개를 들 수 있습니다.현재 "소개"의 전체 목록입니다.항목은 카테고리:소개 기사, 이렇게 보충된 주요 기사 목록은 카테고리:별도의 소개가 있는 기사.

위키피디아의 WP 정신에 따라:정책이 아닌 WP:LED 지침 및 컨텐츠 포킹에 대한 지침, 별도의 소개 기사 수를 최소화해야 합니다.시작하기 전에 스스로에게 물어보십시오.

  • 앞 절에서 제시한 조언에 따라 별도의 소개 없이 기사 전체를 충분히 이해할 수 있습니까?
  • 당면한 주제에 대한 일반적인 관심의 정도를 고려할 때 잘 작성된 리드로 충분할까요?

소개를 시작할 수 있습니다.이 질문들에 대한 답이 "아니오"인 경우 기사.

참고 항목

외부 링크

  • "Topic: Writing for the Web". Nielsen Norman Group.
  • "15–Writing Web Content". Research-Based Web Design & Usability Guidelines (PDF). U.S. Department of Health & Human Services. August 15, 2006. ISBN 0-16-076270-7.
  • "Plain Language Action and Information Network". U.S. Federal Government.
  • "Guidelines for preparing patient education handouts". Center for Professional Practice of Nursing. UC Davis. Archived from the original on 2013-12-07.