Rutile3.techの記事作成ルール

概要

新規作成する記事では、できるだけ以下のルールに従って記述する。

既存記事については、必要に応じて随時修正する。

タイトル

記事タイトルは、原則として以下の形式で記述する。

code:タイトル例

【GAS】時間ベーストリガーの多重実行を防ぐ（LockService）

【Eclipse】コード補完機能を有効にする

【SQL*Plus】Oracle Databaseに接続する

ただし、用語解説やメモ記事など、対象技術を限定しない場合はこの限りではない。

リンク

専門用語、ツール名、機能名などは積極的にリンク化する。

code:リンク例

同じ記事内で同じ単語が何度も出る場合は、

初出または重要な箇所を中心にリンク化する。

見出し

本文は、必要に応じて以下のような見出しを使用して整理する。

code:見出し例

概要

手順

使用例

補足

参照

手順を説明する記事では、できるだけ「概要」→「手順」→「補足」→「参照」の順に記述する。

ハッシュタグ

記事の末尾には、記事に関連する項目をハッシュタグとして列挙する。

code:ハッシュタグ例

ハッシュタグは、検索しやすさを優先して付与する。

表記ゆれを避けるため、同じ技術・ツールにはできるだけ同じタグを使用する。

コードブロック

コードやコマンドは、Scrapbox の code記法を使用して記述する。

code:コードブロック例.sql

SELECT *

FROM juchu

WHERE juchu_id = 1;

コードブロック名には、内容が分かる名前を付ける。

複数のコードブロックを使用する場合は、連番などを付けて別名にする。

code:コードブロック名の例

code:sql_01

code:sql_02

同じコードブロック名を使用すると、

コピー時に複数のコードブロックの内容がまとめて含まれる場合がある。

表

比較、分類、対応関係を説明する場合は、できるだけtable記法を使用する。

table:表例

項目 内容

開発技術 Godot

対象環境 PCブラウザ

画像

画面操作を説明する場合は、必要に応じてGyazo画像を添付する。

画像だけで説明を完結させず、画像の前後に操作内容を文章で記述する。

引用

外部サイトから文章を引用する場合は、引用元を明記する。

code:引用例

引用文

引用文と自分の説明文は混同しないように分けて記述する。

参照

参考にしたページがある場合は、本文中または末尾にリンクを記載する。

code:参照例

表記ルール

括弧で囲む文字

table:括弧で囲む文字

対象 記述 例

画面上の項目 「」 「ウィンドウ」→「設定」を開く

画面上のメッセージ 「」 「保存しました」と表示される

概念・用語 「」 「フォールバック」について説明する

記事名・ページ名 『』 『Rutile3.techの記事作成ルール』を参照する

操作関連

table:操作関連の表現

操作 文言

原則として、「押下」ではなく「クリック」を使用する。