【AI活用】MarkdownとMermaidを始めましょう

みなさんこんにちは
最近は社内のAI活用推進を行っている伊東です。

マークダウン形式使っていますか?

みなさんはテキストのメモをどのように記録、活用していますか?
私は、マークダウン形式を利用し始めて概ね3年ぐらい経過しました。
使い始めた当初は、一部の技術オタクのような人々が使っているような印象でした。

以前の私

以前は、下記のように自力で記号などを用いて段落を表現して書いていました。

■ 見出し1
 ○ 見出し2
  ・箇条書き1
  ・箇条書き2

最近の私

最近は、AIツール群も使い勝手が良くなり、出力された内容をコピーすると、大体マークダウン形式になっています。

最低限覚えておけばよい書式としては以下のようなイメージです。

# 見出し
## 中見出し
### 小見出し
#### 4階層目
##### 5階層目

– 箇条書き
 - ネストした箇条書き

1. 番号付きリスト
2. 項目2

| 列1 | 列2 | 列3 |
|—–|—–|—–|
| 内容 | 内容 | 内容 |

> 引用文

[リンクテキスト](URL)

便利に活用するには?

個人的にMarkdownを扱う際のおすすめツールはVisual Studio Codeです。

プラグインが必要になるため、以下の4種類をインストールします。
他にもおすすめはいくつかありますが、最低限この4つがあると良いです。

必須プラグイン

あると便利プラグイン

実演

filename.mdの形式でファイルを保存します。

エディタ上で右クリックしてプレビューを表示するメニューを選択すると、右側にプレビューが表示されます。
「Markdown PDF」のプラグインをいれていると、PDF出力も簡単に実施できます。

Mermaid記法って何??

様々な図を書ける便利な記述方式です。
RedmineやGit等でも使う機会が多いので、こちらは馴染みがあるかもしれません。
自分で書くにはなかなか大変ですが、最近はAIツールにお願いすると簡単に書いてもらえます。

参考イメージ

graph TD
 A[開始] –> B[処理]
 B –> C{判定}
 C –>|Yes| D[終了]
 C –>|No| B

ブラウザ上で利用できるMermaidエディタも便利です。
Online FlowChart & Diagrams Editor – Mermaid Live Editor

AIツール活用

最近は、AIツールにいろいろな問合せや壁打ちをする機会が増えました。

ツールによっては「ベストプラクティスをまとめたい」といった依頼の場合において、明示的に指示しなくてもマークダウンファイルとして生成してくれる事もあります。
併せて、「Mermaid形式で図を添えてほしい」と伝えれば、状況に合った図をよしなに作成してくれるケースも多々あります。
もちろん、明示的に「Mermaid形式で全体の流れをフローチャートにしてほしい」というようなリクエストをすると的確に作成してもらえます。

プロンプトサンプル

これまでの内容をMarkdown形式の .mdファイル でまとめてください。
必要に応じてMermaid形式で図を添えてください。

上記のようなプロンプトで出力された内容をコピーしたり、.mdファイルで保存したものを先ほどのVSCodeで開けば、素敵な感じに構造化されたファイルが得られます。

さらに応用編

最近のGoogle Docsは、マークダウン形式に対応しました。

「ツール」>「設定」からマークダウンを有効にしておきます。

あとは、「マークダウンから貼り付け」を選択すると、Docsの書式が適用されます。

予め見出し等の書式を設定したDocsにマークダウン形式で貼り付けるとものすごく捗ります。

いかがでしたでしょうか?

マークダウンファイルで作成したものは、 MKDocs 等のツールを活用してブラウザから表示することや、
Obsidian などのツールを活用して、様々な利用が可能となります。

この他にも、マークダウンファイルはAIツール群との親和性も高いため、各種AIツールに読み書きさせるにも相性が良いです。

マークダウン形式で仕様書を書くスタイルも定着しつつあるようなので、みなさんも始めてみてはいかがでしょうか?

--------------------------
開発支援・技術研修のご要望・ご相談はこちらから
--------------------------
【この技術ブログを読んだエンジニアの皆様へ】
カサレアルブログをお読みいただき、ありがとうございます!

私たちは、常に新しい技術に挑戦し、ユーザーのニーズに応えるサービスを提供しています。
もし、当社の技術への情熱や、会社・チーム・社員の雰囲気に共感いただけたなら、
ぜひ私たちと一緒に働きませんか?
現在、株式会社カサレアルでは事業拡大に伴い、新たな仲間となるエンジニアを積極的に募集しています。

少しでも興味をお持ちいただけましたら、まずは弊社のことを知っていただけると嬉しいです。
▼採用サイト
https://www.casareal.co.jp/recruit/career
▼社員インタビュー
https://hrmos.co/pages/casareal/jobs/0000016
▼エンジニアの仲間になる! エントリーはこちらから
https://hrmos.co/pages/casareal/jobs

皆様のエントリーを心よりお待ちしています!

Javaの文字列比較はequalsでいいの?

コメントを残す

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

コメント ※

名前 ※

メール ※

サイト