Agent-Skills.md

Agent Skills: Specification Update Workflow

[Testing] Use when updating specifications, comparing branches, or ensuring documentation reflects current implementation.

UncategorizedID: duc01226/easyplatform/tasks-spec-update

Repository

duc01226/easyplatform
duc01226License: MIT
31

Install this agent skill to your local

pnpm dlx add-skill https://github.com/duc01226/EasyPlatform/tree/HEAD/.claude/skills/tasks-spec-update

Skill Files

Browse the full folder contents for tasks-spec-update.

Download Skill

Loading file tree…

.claude/skills/tasks-spec-update/SKILL.md

Skill Metadata

Name
tasks-spec-update
Description
"[Testing] Use when updating specifications, comparing branches, or ensuring documentation reflects current implementation."

Specification Update Workflow

Summary

Goal: Sync specification documents with current implementation by discovering changes, analyzing gaps, and updating specs.

| Step | Action | Key Notes | |------|--------|-----------| | 1 | Change discovery | Git diff between branches or pattern-based file search | | 2 | Gap analysis | Create comparison table: Specified vs Implemented vs Gap | | 3 | Specification update | Update entity props, commands, validation, side effects, API endpoints | | 4 | Verification | Cross-reference all commands/queries in code vs specs |

Key Principles:

  • Always cross-reference specs with actual code (grep both .md and .cs files)
  • Document both new implementations missing from specs and spec items not yet implemented
  • Update version numbers and change logs after spec updates

When to Use This Skill

  • Syncing specs with implementation
  • Branch comparison analysis
  • Post-implementation documentation update
  • Feature spec verification

Pre-Flight Checklist

  • [ ] Identify specification files to update
  • [ ] Determine implementation changes
  • [ ] Compare current state vs documented state
  • [ ] Plan update strategy

Phase 1: Change Discovery

Git-Based Discovery

# Compare branches
git diff main..feature-branch --name-only

# Get detailed diff
git diff main..feature-branch

# List commits with messages
git log main..feature-branch --oneline

Pattern-Based Discovery

# Find all spec files
find . -name "*.spec.md" -o -name "*-specification.md"

# Cross-reference specs with code
grep -r "SaveEmployee" --include="*.md"  # In specs
grep -r "SaveEmployee" --include="*.cs"  # In code

Phase 2: Gap Analysis

Create Analysis Document

# Specification Gap Analysis

## Implementation Status

| Component                | Specified | Implemented | Gap                    |
| ------------------------ | --------- | ----------- | ---------------------- |
| Entity: Employee         | Yes       | Yes         | None                   |
| Command: SaveEmployee    | Yes       | Yes         | Missing validation doc |
| Event: OnEmployeeCreated | No        | Yes         | Not in spec            |

## New Implementations (Not in Spec)
1. `BulkUpdateEmployeeCommand` - Added in PR #123

## Spec Items Not Implemented
1. `EmployeeArchiveCommand` - Deferred to Phase 2

Phase 3: Specification Update

Update Checklist

  • [ ] Update entity property list
  • [ ] Add new commands/queries
  • [ ] Update validation rules
  • [ ] Document side effects
  • [ ] Add error codes
  • [ ] Document new filters
  • [ ] Update response schema
  • [ ] List event handlers
  • [ ] Describe cross-service effects
  • [ ] Add new API endpoints
  • [ ] Document auth requirements

Phase 4: Verification

Cross-Reference Check

# Verify all commands are documented
grep -r "class.*Command" --include="*.cs" -l
# Cross-check against specs
grep -r "Command" docs/specifications/*.md

Verification Checklist

  • [ ] All implementation changes identified
  • [ ] Gap analysis completed
  • [ ] Specifications updated
  • [ ] Cross-references verified
  • [ ] Version numbers updated
  • [ ] Change log updated

Related

  • tasks-documentation
  • documentation

IMPORTANT Task Planning Notes (MUST FOLLOW)

  • Always plan and break work into many small todo tasks
  • Always add a final review todo task to verify work quality and identify fixes/enhancements