req-fn-app-interface-list

Create structured interface lists mapping data exchanges with external systems.

Updated May 18, 2026
One-click install
npx skills add https://github.com/ABLER-Digital-Services/ai-guild --skill req-fn-app-interface-list
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: req-fn-app-interface-list
Source: https://github.com/ABLER-Digital-Services/ai-guild/tree/main/skills/req-fn-app-interface-list
Command: npx skills add https://github.com/ABLER-Digital-Services/ai-guild --skill req-fn-app-interface-list

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

開発対象システムと外部システム間のデータ連携(API連携・ファイル連携・DB連携など)を、抜け漏れなく一覧化できない課題を解決します。

Core Features & Use Cases

  • IFID採番ルールに基づくインタフェース一覧作成: 相手システムごとに連番で IF-NNN を付与し、設計・開発の入力として使える形に整理します。
  • 必要項目を揃えたレビュー可能な記載: 相手システム名の一致、送受信区分、方式・頻度、認証方式や未確定事項(TODO)などを表形式で統一します。
  • 既存成果物との連携: システム関連図の矢印、バッチ機能、処理一覧の参照関係を整えます(例: バッチ連携はバッチ機能ID、オンライン処理は備考欄で参照)。

Quick Start

インタフェース一覧スキルを使って「システム関連図」と「アクター定義書」を基に、IFIDルールに従いインタフェース一覧ドキュメント(表形式)を作成してください。

Frequently Asked Questions about req-fn-app-interface-list

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create an interface list for system data exchanges?

An interface list maps a target system's data exchanges with external systems. You create structured entries using IFID sequencing rules, strict system-name matching, and required metadata like data content, method, frequency, and authentication notes.

What is the IFID sequencing rule for interface documentation?

The IFID sequencing rule assigns sequential identifiers like IF-NNN for each external system connection. This ensures every API, file transfer, and direct database or MQ connection is uniquely tracked and reviewed within the interface list.

When should I generate an interface list during system design?

You should generate an interface list after system diagrams are created. It maps data exchanges by linking batch processing IDs and online processing references, ensuring alignment between the system diagram and interface documentation.

How do I review existing API and file transfer documentation?

Review existing API and file transfer documentation by checking for strict system-name matching, directional send and receive classification, and required metadata. The list standardizes entries in a tabular format to highlight uncertainties or TODOs.

Does the interface list support direct database and MQ connections?

Yes, the interface list supports direct database and MQ connections alongside APIs and file transfers. It classifies these data exchange methods directionally as send or receive, capturing frequency and authentication details for each connection.