120 lines
5.0 KiB
Markdown
120 lines
5.0 KiB
Markdown
# Documentation Index
|
|
|
|
## Overview
|
|
This directory contains comprehensive technical documentation for the GE Manufacturing Asset Management Scripts. The documentation is organized into specialized areas covering architecture, deployment, integration, and operational aspects.
|
|
|
|
## Documentation Structure
|
|
|
|
### 📋 [TECHNICAL_ARCHITECTURE.md](TECHNICAL_ARCHITECTURE.md)
|
|
**Complete system architecture and design patterns**
|
|
- System overview and component relationships
|
|
- Data collection engine architecture
|
|
- Manufacturing intelligence processing
|
|
- Advanced features and algorithms
|
|
- Performance characteristics and scalability
|
|
- Security considerations
|
|
|
|
### 🔗 [API_INTEGRATION.md](API_INTEGRATION.md)
|
|
**Dashboard API integration and data protocols**
|
|
- API endpoint specifications
|
|
- Request/response structures
|
|
- Database schema integration
|
|
- Manufacturing data payloads (v3.0 enhancements)
|
|
- Connection management and error handling
|
|
- Data validation and integrity
|
|
|
|
### 📖 [FUNCTION_REFERENCE.md](FUNCTION_REFERENCE.md)
|
|
**Detailed function-by-function documentation**
|
|
- Core system functions (`Update-PC-CompleteAsset.ps1`)
|
|
- Manufacturing intelligence functions (`Get-ShopfloorConfig.ps1`)
|
|
- Parameter specifications and return values
|
|
- Error handling patterns and best practices
|
|
- Code examples and usage patterns
|
|
|
|
### [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md)
|
|
**Enterprise deployment strategies and procedures**
|
|
- Single PC and multiple PC deployment methods
|
|
- Enterprise integration (Group Policy, SCCM, Tanium)
|
|
- Configuration management and customization
|
|
- Scheduling and automation options
|
|
- Network considerations and troubleshooting
|
|
- Best practices and change management
|
|
|
|
## Quick Navigation
|
|
|
|
### For Developers
|
|
- [Technical Architecture](TECHNICAL_ARCHITECTURE.md#architecture-components) - Understanding system design
|
|
- [Function Reference](FUNCTION_REFERENCE.md#core-functions) - Implementation details
|
|
- [API Integration](API_INTEGRATION.md#api-endpoint-updatecompleteasset) - Database integration
|
|
|
|
### For System Administrators
|
|
- [Deployment Guide](DEPLOYMENT_GUIDE.md#deployment-methods) - Implementation strategies
|
|
- [Technical Architecture](TECHNICAL_ARCHITECTURE.md#performance-characteristics) - Performance planning
|
|
- [API Integration](API_INTEGRATION.md#connection-management) - Network configuration
|
|
|
|
### For Manufacturing Engineers
|
|
- [Technical Architecture](TECHNICAL_ARCHITECTURE.md#manufacturing-intelligence-engine-get-shopfloorconfig-ps1) - Manufacturing features
|
|
- [Function Reference](FUNCTION_REFERENCE.md#get-geregistryinfo-new-in-v30) - Registry analysis capabilities
|
|
- [API Integration](API_INTEGRATION.md#manufacturing-specific-data-shopfloor-pcs-only) - Data structures
|
|
|
|
## Key Features Documented
|
|
|
|
### v3.0 Enhancements
|
|
- **Dual Registry Architecture**: 32-bit and 64-bit GE Aircraft Engines registry analysis
|
|
- **DualPath Communication**: Complete eFocas DualPath configuration extraction
|
|
- **Per-Service Architecture Tracking**: Registry architecture detection per DNC service
|
|
- **Smart Conflict Resolution**: Priority system for handling dual registry locations
|
|
|
|
### Manufacturing Intelligence
|
|
- **PC Type Classification**: Engineer/Shopfloor/Standard automatic detection
|
|
- **GE Machine Number Extraction**: Hostname pattern matching and conversion
|
|
- **Network Topology Analysis**: Machine network detection and classification
|
|
- **Communication Protocol Detection**: Serial port and DNC configuration analysis
|
|
|
|
### Enterprise Features
|
|
- **Auto-Discovery**: Intelligent dashboard URL detection
|
|
- **Multi-Method Deployment**: Single PC, batch, and enterprise integration options
|
|
- **Comprehensive Logging**: Color-coded status reporting and error handling
|
|
- **Graceful Degradation**: Fallback mechanisms for failed operations
|
|
|
|
## Documentation Standards
|
|
|
|
### Code Examples
|
|
All code examples are tested and validated against the actual script implementations. Examples include:
|
|
- Complete function signatures
|
|
- Parameter specifications
|
|
- Return value structures
|
|
- Error handling patterns
|
|
|
|
### Architecture Diagrams
|
|
ASCII diagrams illustrate:
|
|
- System component relationships
|
|
- Data flow patterns
|
|
- Integration architectures
|
|
- Network communication flows
|
|
|
|
### Cross-References
|
|
Documentation includes extensive cross-referencing:
|
|
- Function calls between modules
|
|
- API endpoint relationships
|
|
- Configuration dependencies
|
|
- Deployment prerequisites
|
|
|
|
## Version History
|
|
|
|
- **v3.0**: Added dual registry architecture analysis and DualPath detection
|
|
- **v2.1**: Enhanced shopfloor configuration documentation
|
|
- **v2.0**: Integrated manufacturing-specific documentation
|
|
- **v1.0**: Initial documentation framework
|
|
|
|
## Contributing to Documentation
|
|
|
|
When updating scripts or functionality:
|
|
1. Update relevant function documentation in [FUNCTION_REFERENCE.md](FUNCTION_REFERENCE.md)
|
|
2. Modify architecture documentation if system design changes
|
|
3. Update API documentation for new data fields or endpoints
|
|
4. Revise deployment procedures for new configuration options
|
|
|
|
---
|
|
|
|
** Comprehensive documentation for enterprise manufacturing asset management** |