Documentation/Style guide/ja

概要
このスタイル ガイドは、MediaWiki やその他の技術系の空間での技術文書の執筆と編集についての指針を提供します. 明確で簡潔な技術文書を、平易な言葉で書くためのヒントが提供されています. 一般的な技術文書の執筆と編集に関する追加のリソースへのリンクも提供されています.

いい技術文書は、人々がウィキメディアのプロジェクト群に貢献することを容易にします. 技術文書の作成や編集において、貢献者や読者のスキルや経験が異なる場合には、明確な標準やスタイルガイドに従うことが重要です. 自分自身を執筆者と考えるかどうかにかかわらず、あなたの貢献は必要であり、評価されています.



英語版ウィキペディアのスタイル マニュアル
英語版ウィキペディアのスタイル マニュアルは、一般的な執筆トピック (句読点など) を詳しく説明し、他のスタイル ガイドの要点をまとめています. ローカル ウィキにより具体的なガイドラインがない場合、ウィキメディアのプロジェクト群全体で英語の技術文書を書いたり編集する人々にとって有用な参考資料になるでしょう.

このページでは、技術文書の執筆に入門するための基本的なガイドラインとヒントが提供されています. ウィキペディアのスタイル マニュアルではカバーされていない技術文書に特化した情報も含まれています.



Writing for technical audiences
執筆する前に、対象読者を考慮します:


 * 誰がこの技術文書を読むのか?
 * どこから来ているのか?
 * あなたが提示する概念についてどの程度知っているのか?
 * 理解するために必要なことは何か?

読者について理解が深まれば、何を伝える必要があるかをより良く把握できるようになります.

Writing with a purpose
What purpose will your technical documentation serve? There are many reasons to write documentation. It is helpful to know why you are writing and what your goal is before you begin.


 * Is it to teach someone, like a newcomer, about a process or concept?
 * Is it to show someone how to follow a process?
 * Is it meant to provide background and context for a concept or process?
 * Is it a reference intended to provide information?

Writing within a context
When deciding what to write and how to frame it for your reader, it can help to define a context or occasion for your writing. Your communication takes place in the context of a bigger situation. The context may be bounded by the era you are writing in, the type of technology available, your geographical location and culture, or the current culture and communication styles of your readers. The occasion may be personal and arise from the situation that motivated you to create or improve a piece of documentation.

For example, if you are writing technical documentation for Wikimedia projects, consider the culture created by the individuals who participate in those projects. How could you best position your writing within the context of this community and its culture to create the most meaningful and useful technical documentation?

User testing and feedback
Create technical documentation to communicate ideas and concepts to a real audience of users. Naturally, this audience should play a critical role in how the documentation is shaped and reshaped. Think about ways you can gather information about your users' experiences. Take some time to answer the following questions:


 * Does your documentation include a mechanism for feedback?
 * Can you engage in timely conversations with the audience to make improvements?
 * Can you use forums like Stack Overflow or mailing lists to check if your document answers the most common questions people have about your specific topic?

Clarity and consistency
Clarity and consistency makes it easier to access, read, and create technical documentation across MediaWiki/Wikimedia projects. Technical documentation is written for a wide audience and edited by a variety of contributors.

Voice, tone, grammar usage, style, and format should be consistent across technical documentation and similar content collections. This helps readers learn how to navigate information and makes it easier for contributors to understand how to edit and add new information.

Deciding on a document type
Identify your main audience, purpose, and context first to decide on the type of document you will create.

言語
This section briefly mentions some topics worth exploring elsewhere in more detail. Always check your words and expressions against these criteria on Wiktionary: Wiktionary entries cover hundreds of languages, explicitly state the grammatical and lexical features of words and their declensions, provide detailed context labels (including about jargon, UK vs. USA English) and expose how translatable terms are in hundreds of other languages.

Plain English
Please remember: many visitors to these pages are not native English speakers.

For documentation written in English, Plain English (also called plain language) works best. Clear writing is the most understandable by diverse audiences, and is also easiest to translate. There are a number of good tools for checking your writing, at Tech News' Writing Guidelines on Meta-Wiki.

Voice and tone
MediaWiki is a place where anyone can edit. Thus, it can be difficult to maintain a consistent voice and tone in the documentation.

Consider using these elements in your writing:

Point of view

 * Use second person ("You" or assumed "You") when addressing your audience.
 * Avoid first person ("I" or "we"), unless you are writing a FAQ with questions asked from the first person perspective.
 * Use an imperative mood for most documentation focused on goals or process.

Dates

 * Always use the full, four-digit year.
 * Use absolute dates ("in May 2037") instead of relative dates ("next year in May").
 * Avoid adding dates that will require regular manual updates. Example: Write  instead of  when referring to the current year, no matter what year it is currently.

概要
All pages should include an overview section (also called the Lead section) that explains:


 * 1) ページの目的
 * 2) Audience of the page
 * 3) Prerequisites the reader will need to know before proceeding (Ex. a working knowledge of Python)
 * 4) Software or tools the reader will need to complete the processes or tasks outlined on the page (Ex. Java installed)
 * 5) Use case, case study, a practical understanding of the product, service or tool in action. (optional)

Table of contents

 * Each page should include a table of contents, so information can be accessed easily.

Titles and headings

 * Use sentence case for headings.
 * Keep heading fonts consistent throughout documentation.
 * Optional use of anchors to link sections or subsections in the same page.
 * Add a blank line after section headings. This impacts how the content is packaged for translation.
 * Do not put a heading before your overview or lead section.

Information flow
Technical documentation pages should follow a consistent pattern across content collections.

An ideal pattern for each page might be:


 * ページ名
 * 導入/概要
 * ヘッダー
 * コンテンツ
 * Subheading if needed
 * コンテンツ

Formatting code examples and other technical elements
Formatting distinguishes code and other technical elements from regular text.

テンプレート
Templates are often used on MediaWiki.org pages. Templates can help to maintain consistency and can make it easier to translate information.

Below are some common templates.

Templates for page formatting

 * caution, fixtext, note, tip, todo, warning - for styles of inline highlight boxes
 * fixme, historical, notice, outdated, update - for page/section message boxes
 * main, see also - for page/section hatnotes (a short note placed at the top of an article)

Templates for MediaWiki core and Git source

 * class doclink, file doclink, js doclink - to link to MediaWiki core's generated documentation
 * MW file - for a box with info and links for a file in MediaWiki core
 * git file - to link to source code

Templates for Phabricator

 * ptag - for the top-right-of-page Phabricator project tag
 * tracked - for the related Phabricator task

Other useful templates

 * - for IRC link
 * Key press - for, e.g. Ctrl, and button for, e.g.
 * ApiEx - for api.php request URLs
 * Api help - to transclude generated API documentation
 * RestOfVariableName - for global variables
 * tag - for a quick way to mention an XML-style tag in a preformatted way

翻訳
All pages on mediawiki.org are candidates for translation into multiple languages. MediaWiki.org is a multilingual wiki, it uses the Translate extension to present alternative translations and manage the translation of pages.



関連項目

 * Some other technical documentation style guides:
 * Google Developer Documentation Style Guide
 * MDN Web Docs Writing Style Guide
 * Technical writing
 * Other language related resources:
 * word-list
 * Naming things
 * Naming things