skills/avdlee__xcode-build-optimization-agent-skill

mirror of https://github.com/AvdLee/Xcode-Build-Optimization-Agent-Skill.git synced 2026-09-14 13:59:59 +08:00

Files

T

Antoine van der Lee 73fa09383f Restructure README for developer onboarding and add OPTIMIZATION-CHECKS.md

Reorder README sections to front-load value: move How It Works and
Community Results above installation details, add an Every Second Counts
impact callout, rewrite How It Works with a mermaid orchestration diagram,
and add a What It Checks summary table linking to the new
OPTIMIZATION-CHECKS.md reference document.

OPTIMIZATION-CHECKS.md catalogues all 12 check categories with detailed
explanations and external references (Apple docs, WWDC sessions, articles).

Add Documentation Sync rules to AGENTS.md so future skill changes keep
README and OPTIMIZATION-CHECKS.md in sync.

2026-03-24 09:17:33 +01:00

3.0 KiB

Raw Blame History

Agent Guidance

This is a multi-skill Xcode build optimization repository.

Layout

skills/ contains six installable Agent Skills, each with a SKILL.md entrypoint.
references/, schemas/, and scripts/ at the repo root are shared support files used by the skills.
.claude-plugin/ contains plugin and marketplace metadata.

Skills

Skill	Purpose
`xcode-build-benchmark`	Repeatable clean and incremental build benchmarking
`xcode-compilation-analyzer`	Swift compile hotspot analysis and source-level recommendations
`xcode-project-analyzer`	Build settings, scheme, script phase, and target dependency auditing
`spm-build-analysis`	Package graph, plugin overhead, and module variant review
`xcode-build-orchestrator`	Orchestrator: benchmark, analyze, prioritize, approve, delegate fixes, re-benchmark
`xcode-build-fixer`	Apply approved optimization changes and verify with benchmarks

Rules

Wall-clock build time (how long the developer waits) is the primary success metric. Every recommendation must state its expected impact on wall-clock time. If the impact cannot be predicted, say so.
Cumulative task time from the Build Timing Summary is diagnostic evidence, not proof of wall-time impact. Xcode parallelizes aggressively, so reducing parallel task time may produce zero wait-time improvement.
Recommend-first by default. Never apply project, source, or package changes without explicit developer approval.
Benchmark before optimizing. Use .build-benchmark/ artifacts as evidence.
Treat clean and incremental builds as separate metrics.
The orchestrator (xcode-build-orchestrator) is the primary entrypoint for end-to-end work.
Shared references and schemas live at the repo root, not inside individual skills.

Handoff Between Skills

When one skill identifies an issue outside its scope, read the target skill's SKILL.md under skills/ and apply its workflow to the same project context. Pass along any benchmark artifacts or timing evidence already collected.

Documentation Sync

When a skill adds, removes, or changes an optimization check, update the matching row in the "What It Checks" table in README.md and the corresponding section in OPTIMIZATION-CHECKS.md.
When a new external reference (Apple doc, WWDC session, article) is used by a check, add it to the relevant section in OPTIMIZATION-CHECKS.md and to references/build-optimization-sources.md.
When a skill is added or removed, update the "Included Skills" table in README.md, the Skills table in this file, and the Skill Structure tree (between the  /  markers in README.md).
OPTIMIZATION-CHECKS.md is the single source of truth for what the agent checks and why. Skill-internal reference docs (under skills/*/references/) contain implementation detail; OPTIMIZATION-CHECKS.md is the developer-facing summary. Keep both layers consistent but do not duplicate implementation detail into OPTIMIZATION-CHECKS.md.

3.0 KiB Raw Blame History