메뉴
Sub-skill of modular-architecture-documentation: 1. Module Definition Framework (+9).
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | modular-architecture-documentation-1-module-definition-framework |
| description | Sub-skill of modular-architecture-documentation: 1. Module Definition Framework (+9). |
| version | 1.0.0 |
| category | business |
| type | reference |
| scripts_exempt | true |
Module Documentation Template:
## Modular Design
Following [DEC-XXX], the system is organized into [N] independent modules:
**Module 1: [Module Name]**
- **Purpose:** [What this module does]
- **Scope:** [What's included in this module]
- **Entry Point:** [Python module path]
- **CLI Command:** `[command-name]`
- **Dependencies:** [External packages specific to this module]
- **Output:** [What this module produces]
*See sub-skills for full details.*
## Modular Design
Following DEC-003 (Modular Architecture, 2025-07-27), the system is organized into three independent modules:
**Module 1: Invoice Automation**
- **Purpose:** Automated invoice generation and delivery
- **Scope:** Template processing, data merging, PDF generation, email delivery
- **Entry Point:** `aceengineer_admin.invoice:main`
- **CLI Command:** `invoice-gen`
- **Dependencies:** python-docx, jinja2, plotly (for invoice charts)
- **Output:** PDF invoices in /reports/invoices/
*See sub-skills for full details.*
## 2. CLI Command Documentation
**CLI Command Documentation Template:**
```markdown
## CLI Interface
Each module provides a dedicated CLI command configured in pyproject.toml:
**Module 1 Commands:**
```bash
[command-name] [subcommand] [options]
# Basic usage
[command-name] --required-arg VALUE
# Common operations
*See sub-skills for full details.*
## CLI Interface
Each module provides a dedicated CLI command configured in pyproject.toml:
**Invoice Automation Commands:**
```bash
invoice-gen [options]
# Generate invoice for single client
invoice-gen --client mkt-a --month 2025-01 --template monthly
# Generate invoices for all clients
*See sub-skills for full details.*
## 3. pyproject.toml Entry Points
**Entry Points Configuration:**
```toml
[project.scripts]
# Module 1
module1-command = "package.module1:main"
# Module 2
module2-command = "package.module2:main"
# Module 3
*See sub-skills for full details.*
## 4. Module Independence Validation
**Independence Checklist:**
```markdown
## Module Independence Validation
For each module, verify:
**Can Run Standalone:**
- [ ] Module has its own CLI command
- [ ] Module can be executed without other modules
- [ ] Module has dedicated configuration section
- [ ] Module's dependencies are clearly defined
- [ ] Module produces independent output
**Clear Boundaries:**
*See sub-skills for full details.*
## 5. Architecture Decision Documentation
**Decision Template (decisions.md):**
```markdown
Class-level Gmail and email operations: multi-account setup, OAuth, triage, extraction, archiving, attachments, unsubscribe, and touchbase workflows.
Conventions for creating consistent Mermaid diagrams including decision node layout, edge ordering, and flowchart direction rules.
Generate interactive validation reports with quality scoring, missing data analysis, and type checking. Combines Pandas validation, Plotly visualization, and YAML configuration for comprehensive data quality reporting.
Class-level Hermes local configuration and setup workflows, including config audit gotchas and Windows installation.
Guide AI model selection based on task complexity, cost constraints, and latency requirements
Sub-skill of modular-architecture-documentation: Overview (+6).