Haxiom

Haxiom とは

Haxiom は、技術ドキュメントを書くチーム向けの共有 Markdown エディター兼ナレッジベースである。

狙っているのは重複だ。同じ説明が複数の場所に書かれ、どれが最新版か誰にも分からないほど乖離していく状態を指す。

情報源について断っておく。確認した時点ではサイトが応答しなかったため、以下の記述は製品自身のページではなく、ディレクトリの掲載情報に基づいている。

重複という問題は限定的だが、社内のドキュメント群が実際に抱えている問題でもある。

できること

執筆は全員で共有するワークスペース内の Markdown で行う。プレーンテキストとバージョン管理に慣れている技術チームに向いている。

同じ単語だけでなく、複数のドキュメントにまたがる重複した記述を探し出す。二つの場所で同じ段落が二重に説明されている状況が、これによって検出される。

同期によってページはリポジトリと整合させられ、記述は説明対象のコードと同じ場所に置かれる。掲げている目的は、散在する wiki からページを集め、誰かが管理する一つの集合にすることだ。ワークスペースの利用は無料であり、共同作業を軸にした製品としては珍しい。

向いている人

技術ライティングやドキュメント担当のチームが明確な利用者であり、社内 wiki を運用するエンジニアリング組織がそれに続く。

オープンソースプロジェクトがガイドを整備する場合にも合うし、自社ソフトのドキュメントを書くプロダクトチームにも合う。

誰も信用していない wiki を引き継いだチームが最も当てはまる。ガイドが複数のリポジトリにある技術グループも対象だ。

最も強く当てはまるのは、信頼されていない wiki を引き継いだチームである。ガイドが二つ以上のリポジトリに分散しているエンジニアリング部門も同様に適合する。

注意点

重複の検出が狙うのは、社内ドキュメントの実際の姿だ。同じ答えが三か所にあり、そのうち二つが間違っている。これは現実の問題であり、役立つかどうかは精度に完全に依存する。正当に似通った記述に警告を出せば、誰も警告を気にしなくなるからだ。

散在する wiki の統合が掲げられた目的だが、重なり合うページを一つにまとめるには、どれを残すかを誰かが決めなければならない。その判断は編集作業であって、検出器が代わりに下してくれるものではない。

Markdown で書かれリポジトリにひも付いたページは、すでにその習慣があるグループには合うが、それ以外には扉を閉ざす。その習慣のないグループにとっては、ツールが一つ減るのではなく一つ増えるだけだ。

サイトに到達できなかったため、現在稼働しているか、上限はどの程度か、無料枠を超えた料金はいくらか、データはどう扱われるかは確認できていない。共同作業向けの製品が無償で提供され、収益の仕組みが見えない以上、チームのドキュメントを預ける前にそこを理解しておくべきだ。