TeamAPI

TeamAPI is a comprehensive solution designed to provide clear visibility into team ownership, accountability, and resource management within organizations. With TeamAPI, all critical information about team structures, including services, roles, members, and interactions, is consolidated into a single teamapi.yml file per team, ensuring that essential details are accessible and versioned in Git. This paradigm reduces the confusion often arising from scattered documentation across wikis and onboarding documents.

Key Features

• Executable Specifications: Executes the teamapi.yml file, enabling functionality such as diagrammatic representations, a read-only REST API, and integration with Large Language Model (LLM) assistants.

• Interactive Team Personas: Each team can have a unique chat persona that facilitates communication and query handling, mimicking real-life team interactions.

• AI-Native Team Knowledge: TeamAPI enhances traditional documentation by integrating AI capabilities directly into team structures:

  • AI agents are treated as essential team members, with clear specifications for roles and capabilities.
  • Persistent knowledge management includes architecture decisions, coding standards, and automated operational procedures.

• Rich Diagram Representation: Automatically generates various organizational diagrams, allowing teams to visualize their interactions, hierarchical structures, and context mappings.

Example Usage

TeamAPI seamlessly maps organizational structures and interactions. Here’s how it can be utilized:

# Validate and render team structures from a sample organization
teamapi validate examples/acme-org
teamapi render examples/acme-org --scope topology

REST API Access

TeamAPI provides a simple REST API to query team information:

# Start the TeamAPI server for the ACME organization
teamapi serve-api examples/acme-org --port 3000

Visual Dependencies and Interactions

TeamAPI offers visual insights into team interactions using the topological view. Here’s an example diagram:

flowchart LR
  enabling_devex["Enabling DevEx"]
  platform_payments["Platform Payments"]
  stream_checkout["Stream Checkout"]
  stream_onboarding["Stream Onboarding"]
  stream_checkout -->|"platform / x-as-a-service"| platform_payments
  stream_checkout -->|"collaboration / depends (Slowing)"| stream_onboarding
  stream_onboarding -.->|"facilitating"| enabling_devex
  stream_onboarding -.->|"depends (OK)"| platform_payments
  classDef default fill:#ede9fe,stroke:#7c3aed,stroke-width:1px,color:#1e1b4b;

Integration with Popular Tools

TeamAPI supports integrations with various tools like CrewAI and Backstage, automatically generating configuration files tailored to each platform’s requirements. Generators for CODEOWNERS and agents documentation foster a collaborative development environment.

For further details and a complete feature breakdown, check the full documentation.

By providing a structured, clear, and dynamic representation of team responsibilities and interactions, TeamAPI aims to enhance organizational efficiency and clarity.