はてなダイアリーのヘルプの執筆・編集について

Hatena::Diary

はてなダイアリー ヘルプ

はてなダイアリーのヘルプの執筆・編集について

■ はてなダイアリーのヘルプの執筆・編集について

はてなダイアリーのヘルプは、はてなスタッフと有志のユーザーによって執筆・編集されています。

はてなダイアリー市民であれば、このヘルプの編集にご参加いただけます。編集の方針について詳しくは以下のガイドラインにまとめています。

参加を希望される方は、グループへの参加申請ページより参加申請を行ってください。申請時のコメントやお書きになっている日記を総合的に判断し、参加の可否を決定させていただきます。


■ はてなダイアリーのヘルプ編集ガイドライン

  • 以下は、はてなダイアリーのヘルプグループ（g:hatenadiary）内のはてなスタッフの日記で発表された、ヘルプの編集に関する方針などをまとめたものです。
  • 疑問点があればグループ内の日記で議論を行うものとします。現時点では掲示板・あしかは使用しません。
  • なお、基本的には自由に書いていってください。

■ キーワードの作成・削除

  • 「はてなダイアリーのヘルプ」グループ内のキーワードの新規登録・削除やデザインの変更の際には、はてなスタッフの日記へのトラックバックまたはコメントを通じて一度連絡してください。
  • キーワードの内容ははてなスタッフにて許可を得ず編集・削除される場合があります。
  • キーワード名を変更(新規作成・削除)した場合は、変更したスタッフ・ユーザーが検索を行い、他のキーワードに含まれるそのキーワードへのリンクを置き換えることとします。
  • 共有ファイル機能が使用可能です。1ファイル5MB以内で画像、動画などをアップロードできます（共有ファイル一覧）。
  • 機能が廃止された場合、参照先保存のためキーワードは削除せず保存することとします。（例：はてなダイアリーキーワードTrackBackシステム）

■ 全体構成

  • はてな記法の分類は以下のとおりです。
    • 入力支援記法
      • 入力支援機能を除く(まさに)はてな記法の中で、後述の「自動リンク」ではないもの。
    • 自動リンク
      • 自動的にリンクとなるもので、はてな外のページへのリンクにもなるもの。
    • はてな内自動リンク
      • 自動的にはてなの各サービスへのリンクとなるもの。
    • 入力支援機能
      • 記法ではないけど、HTMLなどに反応してシステムが補助してくれる機能。例えばcite、title属性。
  • はてなモジュールの分類は以下のとおりです。
    • ナビゲーション
      • 自分のダイアリー内へのリンクを提供しているもの。例えばphotoモジュールはその写真が登録された日へ移動できます。
    • 情報表示
      • （他サービスなどの）情報を表示するもの。自分のダイアリーの外へ出るもの。例えばurllogモジュールは過去に言及したページに移動できます。
    • オプション
      • はてなダイアリープラスを使うことで利用するものや、上記以外のもの。例えばclockモジュール・menuモジュール。

■ 内容構成

  • ページ分量は1024×768のモニターで1スクロール以内に収まる程度とします。
  • キーワードの内容はできる限り簡潔に記述してください。「何をすると」「どうなるか」を明確に記述してください。
  • 「～～ってなに？」というキーワードの内容は、その「～～」の説明から始めてください。
  • 初心者向けのガイド的存在である「はてなダイアリーってなに？」「はてなダイアリーの使い方」以外は「言い切り、簡潔」型で記述してください。
  • 原則として各キーワードの冒頭に1つだけ見出し(見出し記法)をつけてください。
  • 原則として各キーワードの末尾に1つだけ、「関連する情報」を小見出しとしてつけます。
    • はてなダイアリーガイドや各種キーワード、参考資料など、そのキーワードの内容と関連して理解を深めるのに有用なリンクを自由に加えてください。
    • ヘルプ→ガイド→キーワード（Tips含む）の順に並べてください。
    • リンクのしかたは後述。

■ 用語・表記の統一

  • はてな記法の名称ははてな記法一覧に書いてあるものが正式名称です。
    • なお総称は「はてな記法」とします。
  • はてなモジュールの名称は原則「name属性の値(全て小文字)」+「モジュール」が正式名称（例：calendar2jphotoモジュール・blogpetモジュール）。ただし、name="breadcrumbs" は「パンくずリストモジュール」が正式名称です。
    • なお総称は「はてなモジュール」とします。
  • ISBN/ASIN関連の表記ははてなダイアリー日記 - ISBN/ASIN関連の表記についてに準拠します。
  • HTMLのタグは「タグ」ではなく「HTMLタグ」と表記することとします。
  • はてな記法などに使われるカッコの呼称は以下のとおりとします。
    • ( ) … 丸カッコ
    • [ ] … 角カッコ
    • < > … 山カッコ
  • 設定を変更するページや管理画面より確認できるページの位置を示すには、実際の操作手順にて案内します。クリックするリンクやボタンを示すときは半角角カッコ [ ] で囲み、リンク遷移を表すには → を使います。また、リンクはhttp://d.hatena.ne.jp/my/hoge/piyoという形式をつかって、ヘルプを見ているユーザの設定ページに飛べるようにします。記入例を参考にしてください。

（記入例）

ブログの表示モードを変更するには、管理画面の[設定] → [記事の設定]から行います。変更したい表示モードを選択して、[この内容に変更する]ボタンを押して下さい。

と表示させたい場合、次のように入力します。

ブログの表示モードを変更するには、管理画面の[<a href="http://d.hatena.ne.jp/my/config">設定</a>] → [<a href="http://d.hatena.ne.jp/my/configview">記事の設定</a>]から行います。変更したい表示モードを選択して、[この内容に変更する]ボタンを押して下さい。
  • その他の名称はその都度決定していきます。

■ リンクについて

  • リンクを使う動作の表し方には「クリックする」「ジャンプする」「たどる(辿る)」などがありますが、文脈、語感などで適宜使いわけることにします。
  • リンクは原則として a タグで記述します。
  • グループキーワード・ダイアリーへ意図的にリンクする場合に、keyword記法やdiary記法は使わないでください。
  • また、http記法の[http://～～:title]も使わないでください。
  • グループキーワードへの意図的でない自動リンクは、自動リンク停止記法で隠してください。
  • はてなキーワード・グループキーワードへURL直打ちでリンクする場合、同名キーワードがある場合を除き、URL中の「?kid=***」はカットしてください（実質的な違いはありません）。
  • 「関連する情報」において、ヘルプ内へ手動リンクする場合は a タグで記述します。