Initial commit

.claude-plugin/plugin.json

@@ -0,0 +1,15 @@
+{
+  "name": "database-documentation-gen",
+  "description": "Database plugin for database-documentation-gen",
+  "version": "1.0.0",
+  "author": {
+    "name": "Claude Code Plugins",
+    "email": "[email protected]"
+  },
+  "skills": [
+    "./skills"
+  ],
+  "commands": [
+    "./commands"
+  ]
+}

README.md

@@ -0,0 +1,3 @@
+# database-documentation-gen
+
+Database plugin for database-documentation-gen

plugin.lock.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "internal://schemas/plugin.lock.v1.json",
+  "pluginId": "gh:jeremylongshore/claude-code-plugins-plus:plugins/database/database-documentation-gen",
+  "normalized": {
+    "repo": null,
+    "ref": "refs/tags/v20251128.0",
+    "commit": "e763a6855fe53cd9f89cd02055ae95dba9dbfaa9",
+    "treeHash": "fc05ccb715094abb46d79dcc33006be016885fe2f4679606a7ab6496798ac102",
+    "generatedAt": "2025-11-28T10:18:19.726948Z",
+    "toolVersion": "publish_plugins.py@0.2.0"
+  },
+  "origin": {
+    "remote": "git@github.com:zhongweili/42plugin-data.git",
+    "branch": "master",
+    "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390",
+    "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data"
+  },
+  "manifest": {
+    "name": "database-documentation-gen",
+    "description": "Database plugin for database-documentation-gen",
+    "version": "1.0.0"
+  },
+  "content": {
+    "files": [
+      {
+        "path": "README.md",
+        "sha256": "90b88f8a4ff7b4e2d5b7b8b09afca16386e893e48e27bbd76b7a234957a7cda3"
+      },
+      {
+        "path": ".claude-plugin/plugin.json",
+        "sha256": "acd4694a181b7ea42314e8c085f4d7f8fdca8616562132b1fdde39a0ac1bb1ba"
+      },
+      {
+        "path": "commands/db-docs.md",
+        "sha256": "a2b3b008da2b9be5b044e7a29f5d5eaec97171dc57e6b76bc3e681657e09e363"
+      },
+      {
+        "path": "skills/database-documentation-gen/SKILL.md",
+        "sha256": "de331c8847be583c7eddacdd5c19f50cfb005535276a3fb9ab98f108a01a77b2"
+      },
+      {
+        "path": "skills/database-documentation-gen/references/README.md",
+        "sha256": "a2406834fb9a9eb20ee5e05346070a0395a59d2252879cd2932a565c59a61855"
+      },
+      {
+        "path": "skills/database-documentation-gen/scripts/README.md",
+        "sha256": "9cb15970bddf0a5954eece565fc1a73e6298c658ae28dfdf634b5a56b6815952"
+      },
+      {
+        "path": "skills/database-documentation-gen/assets/README.md",
+        "sha256": "8387342661c2cc7cc877b2123b8adf90e1d0799d69a70b457e1f700930f420a6"
+      }
+    ],
+    "dirSha256": "fc05ccb715094abb46d79dcc33006be016885fe2f4679606a7ab6496798ac102"
+  },
+  "security": {
+    "scannedAt": null,
+    "scannerVersion": null,
+    "flags": []
+  }
+}

skills/database-documentation-gen/SKILL.md

@@ -0,0 +1,55 @@
+---
+name: generating-database-documentation
+description: |
+  This skill enables Claude to automatically generate comprehensive documentation for existing database schemas using the database-documentation-gen plugin. It is triggered when the user requests database documentation, ERD diagrams, or a data dictionary. The plugin supports multiple database engines and generates documentation that includes ERD diagrams, table relationships, column descriptions, indexes, triggers, stored procedures, and interactive HTML documentation. Use this skill when you need to document existing database schemas for team onboarding, architectural reviews, or data governance purposes. The trigger terms include "database documentation", "ERD diagram", "data dictionary", and `/db-docs`.
+allowed-tools: Read, Write, Edit, Grep, Glob, Bash
+version: 1.0.0
+---
+
+## Overview
+
+This skill empowers Claude to create detailed database documentation from existing database schemas. It leverages the database-documentation-gen plugin to automate the process, saving time and ensuring consistency. The generated documentation includes ERD diagrams, table relationships, and detailed information about database objects.
+
+## How It Works
+
+1. **Activation**: Claude recognizes the user's request for database documentation, ERD diagrams, or a data dictionary, triggering the database-documentation-gen plugin.
+2. **Schema Analysis**: The plugin connects to the specified database and analyzes its schema, extracting information about tables, columns, relationships, indexes, triggers, and stored procedures.
+3. **Documentation Generation**: The plugin generates comprehensive documentation in various formats, including ERD diagrams, data dictionaries, and interactive HTML documentation.
+
+## When to Use This Skill
+
+This skill activates when you need to:
+- Generate documentation for a new or existing database.
+- Create ERD diagrams for architectural reviews.
+- Produce a data dictionary for data governance purposes.
+- Onboard new team members to a database project.
+
+## Examples
+
+### Example 1: Documenting an Existing Database
+
+User request: "Generate database documentation for the 'users' database."
+
+The skill will:
+1. Activate the database-documentation-gen plugin.
+2. Connect to the 'users' database and analyze its schema.
+3. Generate comprehensive documentation, including ERD diagrams and a data dictionary.
+
+### Example 2: Creating an ERD Diagram
+
+User request: "Create an ERD diagram for the 'orders' database."
+
+The skill will:
+1. Activate the database-documentation-gen plugin.
+2. Connect to the 'orders' database and analyze its schema.
+3. Generate an ERD diagram illustrating the relationships between tables in the 'orders' database.
+
+## Best Practices
+
+- **Database Credentials**: Ensure Claude has the necessary database credentials to access the database schema.
+- **Database Selection**: Clearly specify the database for which documentation should be generated.
+- **Output Format**: Consider specifying the desired output format for the documentation (e.g., HTML, Markdown).
+
+## Integration
+
+This skill can be integrated with other plugins to further enhance the documentation process. For example, it can be combined with a diagramming plugin to customize the ERD diagrams or with a document generation plugin to create more sophisticated documentation formats.

skills/database-documentation-gen/assets/README.md

@@ -0,0 +1,7 @@
+# Assets
+
+Bundled resources for database-documentation-gen skill
+
+- [ ] template/documentation_template.md: Template file for generating the database documentation in markdown format.
+- [ ] examples/sample_database_schema.sql: Example SQL schema for demonstration purposes.
+- [ ] examples/sample_documentation.md: Example of generated documentation.

skills/database-documentation-gen/references/README.md

@@ -0,0 +1,8 @@
+# References
+
+Bundled resources for database-documentation-gen skill
+
+- [ ] database_best_practices.md: Documentation outlining database documentation best practices.
+- [ ] supported_db_engines.md: Documentation detailing the supported database engines and their specific configurations.
+- [ ] erd_diagram_conventions.md: Documentation explaining the conventions used in the generated ERD diagrams.
+- [ ] api_documentation.md: API documentation for the database documentation generation tool.

skills/database-documentation-gen/scripts/README.md

@@ -0,0 +1,7 @@
+# Scripts
+
+Bundled resources for database-documentation-gen skill
+
+- [ ] init_db_docs.py: Script to initialize the database documentation generation process, handling authentication and connection details.
+- [ ] validate_config.py: Script to validate the configuration file for the documentation generation process, ensuring all required parameters are present and valid.
+- [ ] erd_generator.py: Script to generate ERD diagrams from the database schema.