メインコンテンツまでスキップ

annai マニュアルについて

このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）の概要と、このマニュアルの読み進め方を紹介します。

annai でできること​

  • マニュアルの自動生成 — ソースコードを読み取り、使い方・トラブルシューティング・よくある質問を含むマニュアル一式を生成します
  • 差分だけを更新 — コードの変更箇所を検出し、影響のあるページだけを再生成します。毎回すべてを作り直す必要はありません
  • 品質の自動チェック — 生成されたページを7つの観点で自動採点します。基準を満たさないページは自動で書き直されます
  • ワンコマンドで公開 — 生成したマニュアルを、そのまま Web サイトとして公開できます
  • CI/CD（継続的インテグレーション・継続的デリバリー）との連携 — ソースコードを更新するたびに、マニュアルの再生成と公開を自動で実行する仕組みを構築できます

こんな方におすすめです​

  • ソースコードは書いているが、マニュアル作成に手が回らない開発者の方
  • 既存のマニュアルがコードの更新に追いつかず、内容が古くなってしまっている方
  • マニュアルの文体や構成を一定の品質に保ちたいチームの方

このマニュアルの使い方​

このマニュアルは、目的に合わせて必要なページから読み進められる構成になっています。

  • はじめての方 — まず「クイックスタート（すぐに始めるための手順ページ）」を読み、annai の基本的な流れを体験しましょう
  • 初期設定を詳しく知りたい方 — 「はじめに」カテゴリのページで、設定ファイルの作成やカスタマイズ方法を確認できます
  • 日常的に使う方 — 「使い方」カテゴリのページで、マニュアル生成・差分更新・公開の手順を確認できます
  • 困ったときは — 「トラブルシューティング」ページで、よくある問題と解決方法を確認できます
注意

annai を使うには、Node.js 18 以上と Claude CLI（コマンドラインツール）が必要です。 まだインストールしていない場合は、初期設定をするの「始める前に」セクションを確認します。

はじめに読む​

annai を初めて使う方は、以下のページから始めましょう。

関連ページ​