Imported from GioMjds/swe-agent (skills/technical-writer/software-architecture/er-diagrams/SKILL.md). Install upstream with npx skills add GioMjds/swe-agent --skill er-diagrams. Copyright stays with the author.

ER Diagrams

Overview

Document database relationships. Designed to produce clear, maintainable, and comprehensive technical documentation, developer guides, and system architecture artifacts.

Common Use Cases

• Database systems

Key Principles & Architecture

• Core Concept: Implementation of er diagrams in technical writing and documentation engineering.
• Performance & Security Impact: Designed to improve information accessibility, streamline developer onboarding, reduce support overhead, and maintain clear documentation standards.
• Architectural Guidelines: Follow Docs-as-Code workflows, maintain a Single Source of Truth (SSOT), and align technical documentation with software release lifecycles.

Best Practices

1. Ensure technical accuracy through regular reviews, code validation, and continuous integration checks.
2. Maintain clean structure, consistent terminology, and intuitive visual layout across documentation portals.
3. Continuously gather user feedback and update documentation alongside product and codebase changes.