操作方法ブログ記事の書き方

ブログでソフトウェア紹介や操作方法の記事を書きたい。

なんとなく画像に赤枠を入れたり、操作手順を箇条書きにするのは思いつきます。

もっと普及的なテンプレートはないか?

では下記のブログを参考に実際に書いてみましょう。

https://blog.soracom.jp/blog/2018/04/18/howto-techblog/

まずはタイトル付け

ここはイケハヤ氏のブログ手法と同じです、タイトルでもう内容と流れが決まります。

トライ系

    ~をやってみた

    ~をする方法

紹介系

    ~とは

    ~はこんな時に使える

レポート系

    ~に参加した

    ~で分かった事

有名詞(製品名、サービス名、技術名、機能名、イベント名などなど)を盛り込むことを忘れないようにしましょう。

なるほどこれはどうでしょうか?

ドットインストール【サービス名】で機械学習【技術名】を1日で理解。

次は見出しの中見です。

1つの記事には1つの物事や結論になるようにスコープを小さくする(=タイトルと一対一になるように)

記事の冒頭で「何を目的にして、何を行ったか」を書く

1つの記事の中の小見出しを少なくする

全体的に文字数を少なくする

短い技術ブログの例は参考にならない。

文が感情的で読むに耐えない。

コードは背景色を変え見出し。

技術ブログの流れ&テンプレ

トライ系 (参考: トラヒック計測ツール pmacct を使ってみる )

    何を目的に、何をしたのか。(達成できてない場合は「できてません」も冒頭で)

    結論やわかったこと。(要するに、ってやつですね)

    実際に行った事

      準備(例えば OS のバージョンとか、買ったものとか。これ、結構重要です)

      実際にやったこと

    結論やわかったことに対する補足

紹介系 (参考: LTEモデム搭載済みプロトタイプ向けデバイスの販売を開始しました!)

    製品やサービスが開発された背景

    製品の紹介

      製品やサービスの特徴や、使う事でのメリット(スペックは極力書かない)

      使い始めるまでの手順

      どこで買えるの?

      マニュアルへのリンクや、関連サービスの紹介

レポート系 (参考: 伊那市 LoRaWAN ハッカソン レポート)

    参加の目的

    「自分なりの」結論や得られた事(セミナー等の場合)

    当日の様子

      自分が行った事

      発表者と「自分なりの」要約

    参加の感想とふりかえり(目的が達成できたか等)

    レポート系の場合は写真が重要 撮って撮って撮りまくれ

技術ブログを掲載する場所

画像の取り扱いは Google Drive が便利

https://www.google.com/intl/ja_ALL/drive/

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA