II.
LibraryProcess overview
Reference · livelib-process:technical-documentation--data-model-docs
specializations/technical-documentation/data-model-docs overview
Data Model and Schema Documentation - Comprehensive process for documenting entity relationships, database schemas, data flow diagrams, API data models with automated schema visualization, ER diagrams, and detailed field-level documentation following technical documentation best practices.
Attributes
displayName
specializations/technical-documentation/data-model-docs
description
Data Model and Schema Documentation - Comprehensive process for documenting entity relationships,
database schemas, data flow diagrams, API data models with automated schema visualization, ER diagrams,
and detailed field-level documentation following technical documentation best practices.
libraryPath
library/specializations/technical-documentation/data-model-docs.js
specialization
technical-documentation
references
- - ER Diagram Best Practices: https://www.lucidchart.com/pages/er-diagrams
- - Database Documentation Guidelines: https://www.postgresql.org/docs/current/ddl.html
- - PlantUML ER Diagrams: https://plantuml.com/ie-diagram
- - Mermaid ER Syntax: https://mermaid.js.org/syntax/entityRelationshipDiagram.html
- - OpenAPI Schema Documentation: https://swagger.io/docs/specification/data-models/
- - Data Dictionary Standards: https://dataedo.com/kb/data-documentation/data-dictionary-best-practices
example
const result = await orchestrate('specializations/technical-documentation/data-model-docs', {
projectName: 'E-Commerce Platform',
schemaSource: 'database', // 'database', 'api', 'code', 'mixed'
databases: [
{ type: 'PostgreSQL', connectionString: 'postgres://...', schemas: ['public', 'inventory'] },
{ type: 'MongoDB', connectionString: 'mongodb://...', databases: ['orders'] }
],
apiSpecs: [
{ type: 'OpenAPI', path: './api-spec.yaml' },
{ type: 'GraphQL', path: './schema.graphql' }
],
outputDir: 'docs/data-models'
});
usesAgents
- schema-extractor
- relationship-analyzer
- entity-grouper
- er-diagram-generator
- schema-documenter
- data-dictionary-generator
- data-flow-diagram-generator
- documentation-assembler
- documentation-quality-validator
Outgoing edges
lib_applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
lib_belongs_to_specialization1
- specialization:technical-documentation·Specialization
lib_implements_workflow1
- workflow:data-pipeline-deployment·WorkflowData Pipeline Deployment
lib_involves_role2
- role:technical-writer·RoleTechnical Writer
- role:documentation-engineer·RoleDocumentation Engineer
lib_requires_skill_area2
- skill-area:docs-as-code·SkillAreaDocs-as-Code
- skill-area:reference-docs·SkillAreaReference Documentation
Incoming edges
None.