java-update-design

Propose DESIGN.md updates from staged Java diffs and commits.

1|5|Updated Mar 29, 2026
One-click install
npx skills add https://github.com/mdproctor/claude-skills --skill java-update-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: java-update-design
Source: https://github.com/mdproctor/claude-skills/tree/main/java-update-design
Command: npx skills add https://github.com/mdproctor/claude-skills --skill java-update-design

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps DESIGN.md aligned with code changes in Java projects, ensuring architecture docs reflect the current state.

Core Features & Use Cases

  • Detects when architecture or design evidence exists in code (e.g., new entities, services, endpoints) and proposes corresponding DESIGN.md updates.
  • Validates DESIGN.md synchronization by cross-checking code and design artifacts and prompting for explicit confirmation before applying edits.
  • Supports modular DESIGN.md structures and multi-file groups to maintain coherence across a project.

Quick Start

After making Java design-impacting changes, run the update-design workflow to propose DESIGN.md updates.

Frequently Asked Questions about java-update-design

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

FAQPage Schema
How do I keep DESIGN.md in sync with Java code changes?

To keep DESIGN.md in sync with Java code changes, analyze staged diffs and recent commits to detect new entities or services, then propose targeted updates to the design document. This ensures architecture docs reflect the current codebase state.

What is the best way to automate design documentation updates for Java repositories?

Automating design documentation updates for Java repositories involves running an update-design workflow that cross-checks code and design artifacts. It validates synchronization, ensures document integrity, and prompts for explicit confirmation before applying edits.

Do I need a specific DESIGN.md location to sync Java architecture documentation?

Yes, syncing Java architecture documentation requires DESIGN.md at the project root or docs/DESIGN.md. The workflow also supports modular design structures and multi-file groups to maintain coherence across a project.

Can I validate DESIGN.md synchronization against staged Java commits?

Yes, you can validate DESIGN.md synchronization against staged Java commits by analyzing the staged diffs. The validation workflow cross-checks code and design artifacts, proposing updates and prompting for explicit confirmation before applying changes.

How does design sync handle modular DESIGN.md structures in Java projects?

Design sync handles modular DESIGN.md structures in Java projects by supporting modular equivalents and multi-file groups. It analyzes recent commits to propose targeted updates, maintaining coherence across the project's design artifacts.

Why does architecture documentation drift from Java code changes?

Architecture documentation drifts from Java code changes when new entities, services, or endpoints are added without updating DESIGN.md. Analyzing staged diffs detects this design evidence and proposes corresponding updates to keep documents aligned.