Docbase - Markdownから生成する開発者向けドキュメント
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 開発者向けのドキュメントはDX（Developer Experience。開発者体験）を語る上で欠かせない存在です。ドキュメントが間違っているのはもっての外ですが、さらに可読性が高かったり、機能面においても体験を向上できる要素があります。 そんな中、メンテナンスのしやすさもまた大事な要素になります。今回はMarkdownファイルをベースにしたドキュメントシステム、Docbaseを紹介します。 Docbaseの使い方 利用例です。トップページのデザインも格好良いです。 ドキュメント詳細です。右側に目次、中央にコンテンツが表示されます。 コードは文字が大きく見やすくなっています。 別なドキュメントの例です。ヘッダーやフォントなどをカスタマイズできます。右側のカラムは表示されていません。
openKB - node/MarkdownによるFAQシステム MOONGIFT
Webは疑問を解消するのに使えますが、そのためには疑問（とその回答）をまずどこかに載せておく必要があります。最近ではQ&Aが人気ですが、それでもよくある質問についてはFAQのが役立つ場合があります。 そこで使ってみたいのがopenKBです。自社のFAQシステムを構築するのに使えるでしょう。 openKBの使い方 トップページです。左側にカテゴリ、右側によく見られている記事が並びます。 記事詳細です。Markdown記法で書かれています。下には記事のメタ情報があります。 検索もあります。 openKBを使えばFAQシステムが簡単に構築できます。Markdownベースなので普段から使い慣れている記法で書けるのが便利です。まずデータを蓄積していけばWeb検索で引っかかるようになっていくことでしょう。 openKBはnode/JavaScript製のオープンソース・ソフトウェア（MIT Licen
Raneto - node製/Markdownのナレッジベース MOONGIFT
企業のWebサイトなどでよく見られるのがナレッジベースです。FAQ的なものですが、検索がついていたりカテゴライズもされていて、より洗練されたものとなっています。 今回はそんなナレッジベースを作成するためのソフトウェア、Ranetoを紹介します。 Ranetoの使い方 インデックスです。カテゴリ毎にタイトルが並んでいます。 詳細です。左側にインデックスが並びます。 管理者としてログインしました。見た目は特に変わりません。 編集画面です。フォーマットはMarkdownとなっています。 メタデータの編集もできます。 日本語も利用できます。 新しいページの作成も可能です。 Ranetoを使うとユーザ向けによくある質問集をまとめて管理できます。これは社外はもちろん、社内でも使ってみても良さそうです。まずセルフサポートできる形にすれば、より解決が早くなるでしょう。 Ranetoはnode/JavaSc
Knowledge Base - node製のナレッジベース
Webサービスを使う上で質問があったり、ドキュメントが必要になることは多々あります。そんな時に使えるのがナレッジベースです。APIドキュメントやFAQなど色々な用途で使われています。 今回はDOBTというサイトで使われているナレッジベース、Knowledge Baseを紹介します。シンプルで見やすいドキュメントビューワーになっています。 Knowledge Baseの使い方 Knowledge Baseは文書はMarkdownで記述します。それをKnowledge BaseがHTMLに変換しています。さらに検索機能が提供される形です。様々なコンテンツに対して適用できるのではないでしょうか。社内で使っても良さそうですね。 Knowledge Baseはnode/JavaScript製、MIT Licenseのオープンソース・ソフトウェアです。 DOBT Knowledge Base dobt
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
