mcpField
D
docs-curate

docs-curate

github.com/rheinmirドキュメント10137 回インストール2 週間前に更新
リポジトリ

docs-curate について

蓄積したローカル文書を整理するための llmwiki 向けスキルです。保持、アーカイブ、wikiへの反映を分け、スクリプトでファイル移動とインデックス生成を行います。

主な機能

  1. 01保持・アーカイブ・反映の分類を確認
  2. 02重要な決定やパターンをwikiへ反映
  3. 03ファイルを削除せず用途別に保管
  4. 04現行文書とアーカイブの索引を再生成
  5. 05wikiの索引を検証し変更を記録

活用シーン

  1. 01増えたローカルHTMLや草稿の整理
  2. 02提案書、レポート、旧版のアーカイブ
  3. 03設計上の決定や教訓をwikiに記録

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/rheinmir/setup --skill docs-curate

インストール後、Claude Code で/docs-curateを入力して読み込まれたか確認します。

詳細

スキル:docs-curate

使用する場面

  • llmwiki/html/ または wiki/sources/draft/ にローカルファイルが大量に蓄積している場合(長期間の作業で多くのレポートや提案が生成された後など)。
  • 「貴重なドキュメントがあるものの、整理されておらず、見つけにくい/clone したときに失われる可能性がある」と感じた場合。

3 層に分ける理由(単に「統合」するのではなく)

ローカルの HTML を統合しても、依然として LOCAL のままです。別のマシンでリポジトリを取得しても、HTML や draft ファイルは gitignored なので、やはり失われます。本当に「貴重」なのは 設計上の決定/学び/パターン です。これらは wiki(引き継がれ、コミットされる場所)に移す必要があります。一方、レンダリング結果(HTML、draft レポート)は一時的なものなので、アーカイブします。ツールは分類、移動、インデックス作成を確定的に行います。内容を読み解いて昇格させる作業は、あなた(エージェント)が行います。

手順

  1. 計画(dry-run、ファイルには手を加えません):
    python3 fdk/tools/docs-curate.py plan        # in 3 tầng KEEP / ARCHIVE / PROMOTE?
    
  2. 本当に貴重な内容を wiki に昇格 — アーカイブの前に必ず実施(エージェントが判断します):
    • PROMOTE? の各項目と、提案のペアの ARCHIVE に含まれる各 draft について、内容を読みます。wiki にまだない決定/学び/パターンが含まれている場合は、次のいずれかとして記述します。
      • 1 つの決定なら llmwiki/wiki/sources/adr/ADR-NNN-<slug>.md、または
      • 1 つの概念/パターンなら llmwiki/wiki/concepts/<slug>.md。 適切な YAML frontmatter(type: など)と ## Origin(元の draft/commit を参照)を記述します。wiki/index.md と wiki/log.md を更新します。
    • すでに wiki/git にある場合は、昇格させず、アーカイブだけにします。
    • ありふれたもの(進捗レポート、重複したレンダリング結果)は昇格させません。「マシンや他の人が読む価値のあるもの」だけを対象にします。
  3. 適用(機能別に ARCHIVE へ移動し、自動でインデックスを再作成):
    python3 fdk/tools/docs-curate.py apply        # archive theo nhóm + reorg file đã-archive + reindex
    
    • アーカイブはフラットにしません。機能別に archive/<group>/ にまとめます。proposals/(draft と seq のペア)、superseded/(置き換えられた版)、analysis/(昇格を検討する分析)、reports/ を使用します。
    • 以前にアーカイブしたファイルも整理します(archive 直下にあるフラットなファイルを、適切なグループにまとめます)。すでにアーカイブに入っているファイルも対象です。
    • アーカイブ全体にインデックスを作成します。グループ別の索引 llmwiki/html/archive/INDEX.md(再検索できる状態を維持)、index.html ダッシュボード(active)、wiki/index.md(R3)を生成します。
    • 追加のアーカイブは行わず、整理とアーカイブのインデックス作成だけを行う場合:python3 fdk/tools/docs-curate.py reindex。
    • active として保持する日付マーカーの数を調整する場合:apply --keep-dates 3。
  4. 検証してコミット: 新しい index.html(active)と archive/INDEX.md(グループ別アーカイブ)を確認し、wiki/index.md が R3 と一致していることを確認します(dev framework の場合は fdk-gate を実行)。コミットには新たに昇格した ADR/concept を含めます(archive/ と index はローカルの gitignored)。log.md に追記します。

ルール

  • ARCHIVE の前に PROMOTE — 貴重な内容を含む draft を、wiki に昇格させる前に決してアーカイブしないでください(ローカルの gitignored ファイルなので、失うと本当に失われます)。
  • アーカイブは移動であり、削除ではありません — ファイルは archive/ に移動し、内容はそのまま保持します(貴重なドキュメントなので、active なワークスペースから移すだけです)。
  • Canonical(overstack.html、index.html、*-cheatsheet、*-health-dashboard)は決してアーカイブしません。
  • 役割を明確にします。ツール = 分類/移動/インデックスの再作成(確定的な処理)、エージェント = 昇格(読み解き)。混同しないでください。
  • 新しい wiki エントリには必ず ## Origin を設け、wiki/index.md と wiki/log.md を更新します(ルール R2/R3)。

コメント