Ko:위키 지침

From OpenStreetMap Wiki
Jump to navigation Jump to search
개요 지침 구성 번역 Cleanup 프로젝트 도움말

The following Wiki guidelines should be followed when writing wiki pages. This will help create a useful and easy to use wiki, that is accessable to everyone. WikiProject Cleanup is a page coordinating work on the wiki in part to increase conformance with these guidelines.

다음 위키 지침은 위키 페이지를 작성할 때 따라야 한다. 이것은 유용하고 사용하기 쉬운 위키를 만드는 데 도움이 됩니다, 즉 모두가 접근할 수 있습니다. WikiProject Cleanup는 이 가이드 라인을 따라 증가 부분에 위키에 대한 작업을 조정하는 페이지입니다.

Understandability

Keep pages short, use simple language and avoid jargon. OpenStreetMap aims to be accessible to all, and our documentation should reflect this. Aim your writing at the level of children and grandmothers!

Some wiki pages naturally take the form of technical documentation. Even within these we should aim to be understandable to users with a range of technical abilities. Write simple introductions to lead into a topic, and consider splitting off very complex details to separate more focussed wiki pages.

이해도

짧은 페이지를 유지하라, 간단한 언어를 사용하고 전문 용어를 피하십시오. OpenStreetMap는 모든 사람이 액세스 할 수 있는 것을 목표로 합니다, 우리의 문서는 이를 반영해야 한다. 어린이와 할머니도 이해 할 수 있는 수준으로 쓰기를 목표로 해라!

일부 위키 페이지는 자연스럽게 기술 문서 형태를 취한다. 심지어 이 안에서도 우리는 기술 능력의 범위와 사용자가 이해할 수있는 것을 목표로 한다. 주제로 이끄는 간단한 도입 부분을 써라, 그리고 더 많은 초점을 맞춘 위키 페이지를 분리하는 매우 복잡한 세부 사항을 분할할 수 있는 간단한 소개를 작성합니다.


Structure

The wiki should be arranged to allow people to easily find the content they are looking for starting from the Main Page. Some key content is linked directly from the Main Page, but other main page links take you to 'start pages' on a particular topic. They are the next level in a kind of navigation hierarchy. They are often short pages with many links and not too much text (also known as 'portals'). Work is needed to ensure that this navigation is still working effectively for new visitors.

구조

위키는 사람들이 쉽게 메인 페이지로 부터 찾고있는 콘텐츠를 잘 찾을 수 있도록 배치하여야 한다. 일부 주요 내용은 메인 페이지에서 직접 연결되어 있지만, 다른 메인 페이지 링크는 특정 주제에 대한 '페이지를 시작합니다'. 그들은 운행 계층 구조의 다음 단계입니다. 그들은 종종 많은 링크 (또한 '포털'로 알려진) 너무 많은 텍스트가 아닌 짧은 페이지입니다. 운행이 여전히 새로운 방문자에게 효과적으로 작동하는지 확인하는 것이 필요합니다.


Conflicting information

Conflicting information is very bad. Information about current tagging recommendations should be consistent. If this is not the case please get in touch with other users to develop a consensus. Tagging recommendations should ideally match actual tagging practice, unless there is a valid reason not to do so.

Proposals and proposed changes to tagging are the exeption to this rule. They must however be clearly be identified as proposals.

충돌 정보

충돌하는 정보는 매우 나쁘다. 현재 태그의 권장 사항에 대한 정보는 일관성이 있어야 합니다. 이러한 경우가 아니라면, 다른 사용자가 합의를 개발하기 위해 연락주세요. 태그 달기 권장 이상적으로 일치해야 실제 태그 연습을 그렇게 할 수 없는 타당한 이유가 있는 경우를 제외하고는,.

제안 및 태그에 제안 된 변경 사항은 이 규칙에 exeption 있습니다. 그러나 그들은 명확하게 제안으로 식별 할 수 있어야 합니다.


Duplication

Duplication is often bad because it risks providing conflicting information and increases the amount of work. Where there is unnecessary duplication, it should be rationalised to provide a single clear source of information. This may require discussion with other users! It is fine to summarise a topic in another page but that summary would link to the main page.

Template:merge is used to label pages which require reorganisation to remove duplication.

Where duplication is useful (for example, it is being presented in a different style, page structure, or for differing audiences), it is important to be clear about the reasoning for this, and cross-link to avoid confusion. If there is no good reason for duplication, then the pages should be merged. Note that a merge does not necessarily mean we are left with one page where there were two before. There are other outcomes, for example a non-technical summary page page may link to a more detailed technical page.

Titles - Page naming convention

Please follow Wikipedia capitalising naming conventions: For multiword page titles, leave the second and subsequent words in lowercase unless the title phrase is a proper noun that would always occur capitalized, even in the middle of a sentence.

Do not use CamelCasePageTitles in which words are jammed together with no spaces - MediaWiki allows us to use spaces as in natural language. The exception to this would be where the page title is the name of something which does typically have its words jammed together e.g. "OpenLayers"

Prefixes in page titles have been used heavily in the past (e.g. the 'WikiProject' prefix). This is mostly a cumbersome legacy, but not one we can easily rectify at this stage. Moving all such pages would be too big a task. However creating new page title prefixing schemes is strongly discouraged. Use natural language page titles, and cross-link a set of pages to create linking structures in the content of the pages themselves. Please refer to the Wiki organisation for the current discussion on this topic.

Introduction

Pages should start with a short introductory paragraph comprising a few sentences. This should includes the title in bold and explain what the page is about. It's often useful to include a link to a more general page and to any more specific pages, as this helps navigation.

This introductory section should appear before any headings (and before the Table of Contents on a long page). Note that it is fairly common for people to create a first heading "Introduction". This should be restructured so that at least part of the introduction is at the top of the page above any headings. This will achieve a consistent layout across the wiki.

Linking

Pages should be well linked to help users find the information they are looking for. Important related concepts are usually linked to within the introduction. If you can't think of a related wiki page to link from here, then you're probably not describing the page in broad enough terms. You are also encouraged to link to related concepts throughout the rest of the page.

Linking a section to a main page

The {{main|page name}} code could be used under a section heading to provide a link to a main page relating to the subject of the section. The section should then only summarise the linked 'main' page (and should certainly not conflict with it in any way). The title for the section should normally be the same as the page to which it is linked.

Wikipedia linking

Wikipedia links can be confusing. Only link to wikipedia if it's useful, and if the concept is not better explained in an OSM context on this wiki.

If using the [[wikipedia:page name]] interwiki syntax, please leave the 'wikipedia:' prefix in place i.e. Don't do alternate link text: [[wikipedia:page name|page name]] as this is hugely confusing in a basic navigational sense. Don't link to a wikipedia page where the same or similar title exists on this wiki.

Page about a website

We have lots of wiki pages dedicated to describing some external website (map services, software products etc). Obviously the external link to that site is hugely important. The main link should be placed in brackets after the title (which is bold) in the very first sentence and/or linked in larger text on it's own line after the top descriptive sentences.

On these pages there is no point duplicating lots of 'about' information found on the external site. The page should describe the site in an OSM context. Be more neutral and less promotional with your description, although do aim to use language which promotes OSM and uses of OSM.

Listing software / services

We have a number of pages containing bullet pointed lists or wiki tables listing software / services. If we have wiki pages about the software, or even if we haven't (red links) the preferred format is an internal link to the OSM wiki page followed by an external link to the site in brackets. This might then be followed by a short description or other table columns. We should aim to provide links to both the wiki page and the external link even where the wiki page doesn't exist yet to encourage a healthy level of wiki interlinking. Red links can be filled in with stub information following the advice above.

Full URL external links can be nice, if they are short, since the user knows what to expect when they click it. Alternate link text should be used to shorten this, preferably to the domain name so that it's still clear that this is an external link.

Example:

In very space constrained situations (often in the case of wiki tables) we might use the numbered link syntax (e.g. [1]) to shrink the external link right down. We might opt to drop the external link and only link the wiki page, since this will itself have the external link. If the wiki page doesn't exist we might opt to only provide an external link, but it might be better to create a wiki page with stub description.

Categories

Categories should be used to group pages by type which should follow the same naming conventions as with wiki pages.

Categories can themselves be categorised to create a hierarchy to help navigation to the subject of interest. For example Category:Buses is categorised within Category:Public transport.

Pages can be part of a number of categories but should not 'spam' categories. A page relating to buses (for example, a page about bus stops) should be categorised as 'Buses' but not also as 'Public transport'. However, the main Buses page should be tagged within the 'Public transport' category as well as the more specific one.

A single line introduction should be provided for every category which should in general link to an appropriate 'main' page for the subject, ideally of the same name. For example 'Pages relating to [[Public transport]] as an introduction to the category 'Public transport'.

When being categorised, pages should use the sort order option if necessary to ensure that they appear appropriately in the list of pages. For instance look at the pages listed in Category:Users in London. They would all be listed under 'U' because of the 'User:' prefix, but this has been overridden. For example the User:Harry Wood has the category wiki text: [[Category:Users in London|Harry Wood]] with the sort phrase provided after the '|'.

Language

OpenStreetMap uses British English for general English pages and the appropriate 'local' English for localised topic pages. So any page which mostly concerns the U.S., for whatever reason, would use American English. This particularly applies to place pages under Mapping projects.

Translation

See Wiki Translation. This includes some introductory philosophical thoughts on what we aim to achieve with translations within the wiki, while it's not clear whether the wiki will migrate to the Translate extension.

Date formatting

Dates should be formatted in one of these ways depending on the precision required:

  • 12 August 2009 (the normal format, unless there is uncertainty or where the day is highly relevant)
  • Wednesday 12 August 2009 (for when the day of the week matters)
  • 1 August 2009 (no need for the leading zero in the day value)
  • August 2006 (day of month is not known nor relevant)
  • 2009
  • 'Soon' (August 2009) (when a prediction was made at a particular time)

Ordinal suffixes (th, nd, rd) are not necessary, and days and months should be written out in full. Avoid incomplete dates that are unclear, and avoid the use of seasons (summer in the northern hemisphere is winter down south!).