All skills
google avatar

/adk-unit-design

@29933ce
by googlegoogle/adk-python22k stars
4,084

Writes an as-built architecture document for one ADK code unit — purpose, execution flow, data flow, cross-class dependencies, extension points, and the parts that must not change — to `docs/design/{topic}/{unit}/index.md`. It describes the code as implemented, not a proposed design, and its reader is a developer about to change or extend that unit. Use when asked to "write a design doc for {file}", "document the architecture of {class}", "document the extension points of {unit}", or after adding a core class, node type, or plugin base. Don't use for documentation aimed at developers who only call the unit from their own application — that is a usage guide with runnable examples under `docs/guides/` (use `adk-unit-guide`). Don't use to answer a framework-wide architecture question (use `adk-architecture`).

Use this Skill: https://skilld.dev/gh/google/adk-python/adk-unit-design

This session only. Nothing lands on disk.

referencesdesign-template.md

≈329 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Unit design document template

Copy this structure into docs/design/{topic}/{unit}/index.md. The bullets are instructions for what to write in each section, not text to keep.

# {unit_name} - Code Unit Design

Two-sentence summary of the code unit.

## Introduction

Prose covering:

- The purpose and application of the unit, including intended use cases.
- The developer problems it solves.
- The agent capabilities it enables.

## High-level architecture

- Where the unit sits in the wider ADK framework.
- Its general execution flow.
- Data flows it handles, including inputs and outputs.
- Cross-class dependencies, upstream and downstream.

### Extension points

How the unit is meant to be extended or customised, naming the surfaces that
actually exist in the code: abstract classes, interfaces, hooks, callbacks,
configurable parameters, plugin registration.

### Extension constraints

What must not be modified, and why — architectural constraint, implementation
limitation, or a dependency that would break.

## Limitations

Known limits: input and output constraints, data-structure constraints,
performance and memory limits.

Omit a section outright when the code gives you nothing to put in it. An empty "Extension points" heading tells the reader less than its absence does.

Source: SKILL.md on GitHub

No alerts1mo3 checks · Risk SAFE
  • Gen Agent Trust Hub1mo

    This skill assists in the creation and maintenance of software design documentation within the ADK development framework. It includes standard considerations for tools that process source code and interact with the local file system.

  • Socket1mo

    No alerts

  • Snyk1mo

    Risk: LOW · No issues

Signed by skilld at 29933ce. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 months ago

README badge

README badge for google/adk-python/adk-unit-design