spike(framework): assess offline reliability of tool documentation references

オープン
#1,235 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発

調査の方向性

Start by inventorying external vendor-documentation URLs in the installed skills, beginning with plugins/aidd-context/skills/06-agent-generate/references/tool-paths.md, 04-skill-generate/references/tool-write.md and 08-hook-generate/references/tool-paths.md, and classify each as citation, optional verification or required runtime lookup. Then run representative generation flows with documentation domains unreachable and record what the agent does. Done means a written inventory, reproduction results, and a recommendation with any follow-up issues scoped separately.

索引モデルが issue の本文から書いたものです。

説明

Problem

AIDD's tool-specific generation skills contain official documentation URLs for Kilo Code, Claude Code, Codex, OpenCode, Cursor, Copilot and other hosts. Source links are important for verifying platform contracts, but external documentation domains can be inaccessible in restricted enterprise networks.

Not every link creates a runtime dependency: many references already describe the contract locally. However, some instructions explicitly tell the agent to consult vendor documentation for information not recorded in the installed reference (for example, supported hook events). It is not yet established whether those workflows continue safely and reliably when the documentation cannot be reached.

This is a research spike, not a demonstrated product bug. The goal is to determine whether there is an actual offline-runtime gap and agree on an approach before proposing implementation changes.

Scope

  • Inventory external vendor-documentation links in the installed AIDD skills, references, agents and rules; classify each as a citation, optional verification or potentially required runtime lookup.
  • Trace representative generation flows for agents, skills, rules, commands/workflows and hooks across the supported hosts.
  • Run reproducible restricted-network scenarios where vendor documentation access is unavailable, distinguishing cases with a locally sufficient contract from those that require missing information.
  • Identify whether agents fail closed, invent unsupported facts, skip mandatory validation or block unnecessarily when a source is unavailable.
  • Propose a framework-wide convention for locally sufficient execution contracts, optional source verification, evidence freshness and explicit handling of unknown or unverified behavior.
  • Identify small follow-up implementation issues only where a reproducible gap exists, without requiring wholesale copies of vendor documentation.

Acceptance criteria

  • A documented inventory identifies external documentation lookups and their role (citation / optional / required) with file references.
  • Representative supported generation workflows are tested with documentation domains unreachable; reproduction steps and observed results are recorded.
  • The report distinguishes actual runtime dependencies from harmless source links and identifies the behavior when a required fact cannot be verified.
  • A proposed convention preserves official URLs, evidence provenance and verification dates while defining what must be available locally for reliable generation.
  • Any limitations, security considerations and maintenance trade-offs (including documentation drift) are documented.
  • The spike concludes with a clear recommendation and separately scoped follow-up issues, if warranted.

Prior art in this repo

  • #618 — source-backed, dated and auditable tool references. Its requirement to avoid guessing tool behavior must remain intact.
  • #1149 — deterministic framework-file validation; related, not a replacement for offline workflow testing.
  • PR #992 — Kilo-native generation; example references:
    • plugins/aidd-context/skills/06-agent-generate/references/tool-paths.md: local agent mapping plus official vendor links.
    • plugins/aidd-context/skills/04-skill-generate/references/tool-write.md: locally defined targets with sourced platform contracts.
    • plugins/aidd-context/skills/08-hook-generate/references/tool-paths.md: requests external documentation checks for some hook events.
  • aidd_docs/README.md describes local marketplace installation for offline use; this spike examines workflows after installation, not marketplace download.

Out of scope

  • Blocking or expanding PR #992 solely because it contains external documentation URLs.
  • Removing official sources or replacing evidence-backed claims with unsourced assumptions.
  • Vendoring entire provider documentation sites or introducing a live network requirement into every generation.
  • Implementing a fallback, caching system or large-scale refactor before the investigation establishes a concrete need.
主要言語
TypeScript
スター
481
フォーク
45
平均マージ
1日 13時間
マージ済み PR(30日)
91

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ai-driven-dev/framework のほかの issue

ai-driven-dev/framework の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。