見出し画像

docmdは、 .md形式で戦略設計すれば自動でサイト作成してくれるツール

l.threads.com/?u=https%3A%2F%2Fosp.fyi%2Fdocmd&e=AUDlWkJYVuVWoxDhEGJ-ca0tKwXaR_TKAwziyHMaH71MtDm2ds8igDpv49n7zFubWysH8sP4Hk2-p3SgkBS38BZyo4lrY2obtPsB9OiT6WkJbtSgjLsEYI4xhokdGWtHhW8uNBj_HzXqEe4M9gDPNZS1-S3V
Docmd は、

「Markdownファイル群から、自動でドキュメントサイトを生成するツール」

です。

ソフトウェア開発者向けのツールですが、エンジニア以外でも「マニュアル」「業務手順書」「ナレッジベース」の公開に使えます。


何ができるのか?

例えば次のようなフォルダがあるとします。

docs/
├── index.md
├── service.md
├── pricing.md
└── manual/
    ├── login.md
    └── setting.md

Markdownで書かれたこれらのファイルを、

https://example.com/

のようなWebサイトに自動変換してくれます。

結果として、

トップページ
├── サービス説明
├── 料金表
└── マニュアル
     ├── ログイン方法
     └── 設定方法

というナビゲーション付きのサイトになります。


投稿内容の意味

画像の説明を日本語で噛み砕くと、

① ファイル構造から自動ナビゲーション生成

Markdownを置くだけで

目次
サイドバー
パンくずリスト

が自動生成される。


② SEO対応

Google検索向けの設定が最初から入っている。

例えば

<title>
description
OGP
サイトマップ

など。


③ i18n(多言語対応)

日本語版

/docs/ja

英語版

/docs/en

を管理できる。


④ バージョン管理

例えば

v1.0
v2.0
v3.0

のドキュメントを残せる。

ソフトウェアのマニュアルによく使われる。


⑤ オフライン検索

サイト内検索機能を持てる。

ログイン
料金
設定

などを検索可能。


⑥ DocusaurusやMkDocsから移行可能

既存の

  • Docusaurus

  • VitePress

  • MkDocs

などのドキュメントサイトから引っ越ししやすい。


あなたならどう活用できる?


活用例① 顧客向けマニュアル

使い方
├── 初期設定
├── Stripe連携
├── 利用方法
└── FAQ

をMarkdownで管理。

顧客サポート工数が減る。


活用例② 社内ナレッジベース

営業
開発
デザイン
経理

の手順書を集約。

Notionより公開しやすい。


活用例③ コンサルティング教材

第1章 市場分析
第2章 競合分析
第3章 収益モデル

会員向けドキュメントサイトとして提供可能。


活用例④ APIドキュメント

APIを作る場合

認証方法
エンドポイント
サンプルコード

を自動で整理できる。


WordPressとの違い

WordPressDocmdブログ向けドキュメント向けDB使用静的サイト管理画面ありMarkdown編集遅くなりやすい非常に高速セキュリティ管理必要比較的安全


結論

Docmdは、

「Markdownで書いた資料やマニュアルを、プロ仕様のドキュメントサイトに変換するツール」

です。

もしあなたが今後、

  • 社内業務マニュアル

  • 開発ドキュメント

  • API仕様書

を公開する予定があるなら、WordPressでページを量産するより、Docmdのようなドキュメント生成ツールの方が管理しやすいケースが多いです。特に「更新頻度の高い手順書・マニュアル」と相性が良いです。

いいなと思ったら応援しよう!