| name | cross-reference-maintenance |
| description | Maintain cross-references between artifacts and documentation. Identify missing references, update existing references, validate reference integrity, and ensure all links are current. Use when maintaining reference integrity or updating references after changes. |
Cross-Reference Maintenance Skill
Maintain cross-references between artifacts and documentation, ensuring reference integrity and completeness.
When to Use
- Use when maintaining reference integrity
- Use when updating references after file moves
- Use when validating cross-references
- Use when identifying missing references
Instructions
Maintenance Process
- Scan artifacts: Review all artifacts for references
- Identify missing: Find artifacts that should have references but don't
- Validate existing: Check that existing references are valid
- Update broken: Fix broken or outdated references
- Add missing: Add missing references where appropriate
Reference Identification
Missing References
Look for:
- Related artifacts without cross-references
- Documentation without artifact links
- Artifacts without documentation links
- Broken reference chains
Invalid References
Check for:
- Broken file paths
- References to non-existent files
- Incorrect relative paths
- Outdated references after moves
Reference Updates
When Files Move
- Find all references: Search for references to moved file
- Update paths: Update all reference paths
- Verify links: Ensure links work after update
- Check documentation: Update documentation references
When Files Are Added
- Identify related: Find artifacts related to new file
- Add forward refs: Add references in new file
- Add backward refs: Add references in related files
- Update docs: Add to documentation
When Files Are Removed
- Find all references: Search for references to removed file
- Remove references: Remove from all artifacts
- Update documentation: Remove from docs
- Verify cleanup: Ensure no broken references
Validation Checklist
For each artifact:
Examples
Example 1: Adding Missing References
Scenario: New rule created, but related skill doesn't reference it
Action:
- Identify related skill
- Add reference to new rule in skill's "Related Artifacts" section
- Add reference to skill in rule's "Related Artifacts" section
- Update documentation if needed
Example 2: Fixing Broken References
Scenario: File moved, but references still point to old location
Action:
- Find all references to old path
- Update all references to new path
- Verify links work
- Check documentation references
Best Practices
- Validate references regularly
- Update immediately when files change
- Maintain bidirectional references when relevant
- Document reference relationships
- Use relative paths consistently
Related Artifacts