良い記事の書き方ガイドライン
質の高い記事を書く理由
質の高い記事を書くことで、頭の中が整理されて学習効果が高まります。
また、質の高い記事は他の誰かの役に立ちますので、このガイドラインを参考にして、質の高い記事を書けるようになりましょう
質の高い記事とは
あなたの書いた記事は、他のユーザーに公開されますので、
「他のユーザーが読んだ時にわかりやすい記事」を心がけましょう
自分用のメモ書きではなく、他人に教えるつもりで書くだけで、記事の質が高まります
記事タイトルの書き方
記事のタイトルは、Googleの検索結果などに表示されますので、記事の内容がわかりやすいタイトルをつけましょう
×「Pythonメモ」→◎「Pythonのモジュールとライブラリの違い」
×「console.log()」→◎「JavaScriptのconsole.log()の使い方」
×「Rubyエラーでハマった」→◎「RubyのSeleniumでUnknownElementエラー」
×「PHPのインストール方法」→◎「MacにphpenvでPHPをインストールする方法」
記事本文には段落をつける
記事本文は、段落をつけながら情報を整理しましょう
段落の付け方は以下の通りです
ビジュアルエディタの場合
以下のアイコンをクリックします
マークダウンエディタの場合
以下のようにマークダウン記法を使います
# 段落1 ## 段落2
ソースコードの書き方
記事にソースコードを貼る時は、コードブロックを使いましょう
コードブロックの使い方は以下です
ビジュアルエディタの場合
「コード挿入」アイコンをクリックします。
黒いブロックが挿入されるので、その中にソースコードを書きます。なお、黒い画面の中で改行するときは、Shift + Enterで改行します。
マークダウンエディタの場合
バッククォーテーション３つで囲います
環境や前提条件を明確にする
プログラミング情報は、言語のバージョンや環境の違いによって情報が異なりますので、記事の前提となる環境情報を明確にしましょう
環境情報 Mac OS (BigSur) PHP7.0