菜单
Define interfaces between components. Use when specifying API endpoints, data models, event schemas, and integration contracts.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Generate and maintain AI_STANCE.md for any uFawkes* repo. Use when onboarding a repo to the uFawkesAI suite, when reviewing AI policy currency, or when a new AI tool is being adopted. Implements DORA AI Capability 1.
Ensure graphify corpus is current and complete before each agent session. Define minimum AI-accessible documentation per repo. Use at session startup to verify internal context is available to AI tools. Implements DORA AI Capability 3.
15-minute JTBD + acceptance criterion exercise. Use before any spec session. Produces a discovery-brief.md that anchors the entire increment to a real user need and a measurable DORA outcome. Implements DORA AI Capability 6.
Enforce minimum documentation standard across uFawkes* repos. Use when auditing a repo before release, onboarding a new repo to the suite, or implementing roadmap item 0.6 (cross-repo README links). Directly supports DORA AI Capability 3 and the 2023 DORA finding that documentation quality amplifies all technical capabilities.
Create and manage DOJO content for platform engineering education and knowledge sharing.
Maintain AI_STANCE.md as a living document. Use quarterly or when a new AI tool is adopted. Handles review triggers, the three-bucket update process, socialization checklist, and cross-repo consistency. Companion to ai-stance skill.
| name | interface-definition |
| description | Define interfaces between components. Use when specifying API endpoints, data models, event schemas, and integration contracts. |
| license | MIT |
| compatibility | Claude Code, GitHub Copilot, OpenCode, Cursor, Codex, Gemini CLI |
| metadata | {"author":"paruff","suite":"uFawkesAI"} |
Load trigger:
"load interface-definition skill"> DORA: Cap 3 (AI-Accessible Internal Data) Token cost: Low
Define interfaces between components.
component-map.json (from component-identification skill)specification.mdinterfaces.json/api/v1/resource)| Standard | Convention |
|---|---|
| Versioning | URL path (/api/v1/) |
| Naming | kebab-case for paths, camelCase for JSON |
| Pagination | ?page=1&limit=20 or cursor-based |
| Errors | { "error": { "code": "string", "message": "string" } } |
| Timestamps | ISO 8601 format |
{
"apis": [
{
"name": "User API",
"base_url": "/api/v1/users",
"endpoints": [
{
"method": "POST",
"path": "/",
"request": {
"email": "string",
"password": "string" # pragma: allowlist secret
},
"response": {
"id": "string",
"email": "string",
"created_at": "string"
},
"errors": [400, 409, 500],
"auth": "none"
}
]
}
],
"models": [
{
"name": "User",
"fields": {
"id": "string (uuid)",
"email": "string (email)",
"created_at": "string (iso8601)"
}
}
],
"events": [
{
"type": "user.created",
"producer": "User API",
"consumers": ["Email Worker"],
"payload": {
"user_id": "string",
"email": "string"
}
}
]
}