技術ドキュメントの公開とは?
技術ドキュメントの公開とは、技術資料の置き場が決まっていないという状態を、仕組みで解消することです。collabmdは、この用途に使えるオープンソースのひとつです。Markdownや図面をリアルタイムで共同編集できるドキュメント管理ツールです。
- Markdownファイルによる共同編集
- Gitを活用したドキュメント履歴管理
- MermaidやPlantUMLを用いた図面の作成
- Excalidrawを使用したホワイトボード形式の図面作成
- Obsidianと連携したナレッジベースの構築
collabmdを使うと何が変わるのか
このツールは、Markdown形式のフォルダ、図面、およびGitでバックアップされるドキュメントに対するリアルタイムな共同編集を提供します。ExcalidrawやMermaid、PlantUMLといった図面作成機能を備えており、視覚的な情報の共有が可能です。Obsidianとの連携も考慮されており、構造化されたドキュメント管理に適しています。JavaScriptで構築されており、チームでのスムーズな情報共有を実現します。
すでに世界で使われている完成品を土台にするので、同じものをゼロから作るより短い期間で済みます。当社は、この土台に対して日本語化、画面や項目の変更、権限、帳票、既存システムとの連携を加えて、御社の業務に合う状態にします。
collabmdの日本語対応(実測)
collabmdには日本語のファイルがありません。日本語化から始める必要があります。
| ライセンス | MIT |
|---|---|
| 主な言語 | JavaScript |
| GitHubスター | 264 |
| 日本語ロケール | 日本語ファイルなし(0ファイル) |
GitHubの公開ファイル一覧から日本語ロケールの実ファイルを数えた結果です。配布用のビルド成果物は除いています。技術的な詳細はcollabmdのOSS情報にまとめています。
進め方は?
進め方とは、現場を見て対象を決め、動くものを見ていただきながら作り、御社の環境へ導入するまでの流れのことです。書類で仕様を固めてから作る進め方はしません。
1日目(無料)
現場に伺い、いまのやり方を見せていただきます。技術ドキュメントの公開のどこから手を付けるかを決めます。
2〜4日目
collabmdを土台に、御社のPCで目の前で開発します。動くものを見ながらその場で直します。
5日目
御社の環境へ導入し、ソースコードと開発ノウハウをお渡しします。以後は自社で改造できます。
その後
追加の作り込みが必要なら、範囲を決めてあらためてお見積もりします。延長を前提にした進め方はしません。
この方法が向かないのは?
向かないのは、基幹システムの全面刷新や、複数部門にまたがる大規模な仕組みのことです。15時間という枠では作り切れません。また、決まった手順を正確に繰り返すだけの処理は、AIを使わないほうが速く確実です。当社ではその部分は普通のプログラムとして作ります。
技術ドキュメントの公開を、まず15時間で試す
名古屋市内なら、1日3時間×5日間の計15時間・税別15万円で試せます。初日3時間のヒアリングと提案は無料です。御社のPCと御社名義のAIエージェントで目の前で開発するので、作り方ごと社内に残ります。成果物とソースコードはお客様のものです。
AI導入お試し実験を見る 動くデモを先に見る(110,000円〜) collabmdについて相談する技術ドキュメントの公開に使える他のオープンソース
同じ用途に使える土台は他にもあります。ライセンス、日本語対応、規模を比べて選べます。
| 名前 | できること | 日本語 |
|---|---|---|
| BookStack | 社内向けのドキュメント管理やWikiを構築できるプラットフォームです。 | 日本語ファイルあり |
| community | 社内外向けのドキュメント管理と共同編集を可能にするConfluenceの代替ツールです。 | 日本語ファイルが一部のみ |
| gramax | Git管理とMarkdownを活用したドキュメント公開サイトの構築ツールです。 | 日本語ファイルなし |
| CommunityServer | ドキュメント管理やCRMを含む、ビジネス向けの多機能なオフィススイートです。 | 日本語ファイルあり |
| docmost | 社内向けのナレッジ共有やドキュメント管理ができるオープンソースのWikiソフトウェアです。 | 日本語ファイルが一部のみ |