modular-architecture-documentation-1-module-definition-framework

Sub-skill of modular-architecture-documentation: 1. Module Definition Framework (+9).

5 stars

Best use case

modular-architecture-documentation-1-module-definition-framework is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Sub-skill of modular-architecture-documentation: 1. Module Definition Framework (+9).

Teams using modular-architecture-documentation-1-module-definition-framework should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/1-module-definition-framework/SKILL.md --create-dirs "https://raw.githubusercontent.com/vamseeachanta/workspace-hub/main/.agents/skills/_archive/business/admin/modular-architecture-documentation/1-module-definition-framework/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/1-module-definition-framework/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How modular-architecture-documentation-1-module-definition-framework Compares

Feature / Agentmodular-architecture-documentation-1-module-definition-frameworkStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Sub-skill of modular-architecture-documentation: 1. Module Definition Framework (+9).

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# 1. Module Definition Framework (+9)

## 1. Module Definition Framework


**Module Documentation Template:**
```markdown

## 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

Related Skills

agent-os-framework

5
from vamseeachanta/workspace-hub

Generate standardized .agent-os directory structure with product documentation, mission, tech-stack, roadmap, and decision records. Enables AI-native workflows.

module-lookup

5
from vamseeachanta/workspace-hub

Query the digitalmodel module registry to discover modules by capability, standard, or maturity without reading source code.

improve-codebase-architecture

5
from vamseeachanta/workspace-hub

Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/. Use when the user wants to improve architecture, find refactoring opportunities, consolidate tightly-coupled modules, or make a codebase more testable and AI-navigable.

label-driven-prompt-generation-architecture

5
from vamseeachanta/workspace-hub

Pattern for building automation scripts that classify GitHub issues into prompt templates using label-based routing and extract contextual data for batch processing

documentation-contract-plan-hardening

5
from vamseeachanta/workspace-hub

Harden a documentation/contract plan before adversarial review by mapping every issue-scope requirement to independent acceptance criteria and tests, especially for routing/indexing contracts.

repo-architecture-analysis

5
from vamseeachanta/workspace-hub

Scan a Python repo's package structure, count classes/functions, classify module maturity (PRODUCTION/DEVELOPMENT/SKELETON/GAP), and generate architecture reports with Mermaid diagrams. Use when asked to analyze codebase structure, find untested packages, or assess module maturity.

orcaflex-monolithic-to-modular

5
from vamseeachanta/workspace-hub

Convert monolithic OrcaFlex models (.dat/.yml) to spec-driven modular format with semantic validation for round-trip fidelity.

doc-extraction-naval-architecture

5
from vamseeachanta/workspace-hub

Layer 3 domain sub-skill for extracting naval architecture data from SNAME PNA, IMO stability codes, IACS structural rules, and classification society guidelines. Provides detection heuristics for stability constants, resistance equations, hull form coefficients, hydrostatic curves, IMO stability criteria, and structural scantling tables. type: reference

sparc-architecture

5
from vamseeachanta/workspace-hub

SPARC Architecture phase specialist for system design, component architecture, interface design, scalability planning, and technology selection

architecture-diagram

5
from vamseeachanta/workspace-hub

Dark-themed SVG architecture/cloud/infra diagrams as HTML.

multi-tool-architecture-assessment

5
from vamseeachanta/workspace-hub

Systematic comparison of competing tools/approaches before committing to a multi-account, multi-tool architecture. Uses parallel subagents for research, system-state audit, and data quality analysis. Produces a decision matrix with explicit trade-offs.

modular-architecture-documentation

5
from vamseeachanta/workspace-hub

Systematically document multi-module system architectures including module boundaries, CLI commands, and architecture decisions.