@mytechtoday/augment-extensions 1.2.2 → 1.3.0

package/augment-extensions/workflows/adr-support/schemas/adr-config.json

@@ -0,0 +1,191 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://augment-extensions.dev/schemas/adr-config.json",
+  "title": "ADR Configuration Schema",
+  "description": "JSON schema for .adr-config.json configuration file",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "Configuration schema version",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$",
+      "default": "1.0.0"
+    },
+    "adrDirectory": {
+      "type": "string",
+      "description": "Directory where ADRs are stored",
+      "default": "docs/adr",
+      "pattern": "^[a-zA-Z0-9/_-]+$"
+    },
+    "defaultTemplate": {
+      "type": "string",
+      "description": "Default ADR template to use",
+      "enum": ["nygard", "madr-simple", "madr-elaborate", "business-case"],
+      "default": "madr-simple"
+    },
+    "numberingScheme": {
+      "type": "string",
+      "description": "ADR numbering scheme",
+      "enum": ["sequential", "date-based", "custom"],
+      "default": "sequential"
+    },
+    "numberingFormat": {
+      "type": "string",
+      "description": "Format for ADR numbers (e.g., '0001', 'YYYY-MM-DD')",
+      "default": "0000"
+    },
+    "filenameFormat": {
+      "type": "string",
+      "description": "Format for ADR filenames",
+      "default": "{number}-{title}.md",
+      "pattern": ".*\\{number\\}.*\\{title\\}.*\\.md$"
+    },
+    "statusValues": {
+      "type": "array",
+      "description": "Allowed status values for ADRs",
+      "items": {
+        "type": "string"
+      },
+      "default": ["draft", "proposed", "approved", "implemented", "maintained", "superseded", "sunset"],
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "requiredMetadata": {
+      "type": "array",
+      "description": "Required metadata fields in ADR frontmatter",
+      "items": {
+        "type": "string"
+      },
+      "default": ["title", "status", "date", "deciders"],
+      "uniqueItems": true
+    },
+    "customMetadata": {
+      "type": "object",
+      "description": "Custom metadata fields and their types",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["string", "number", "boolean", "array", "object"]
+          },
+          "required": {
+            "type": "boolean",
+            "default": false
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "required": ["type"]
+      }
+    },
+    "integrations": {
+      "type": "object",
+      "description": "Integration settings for external tools",
+      "properties": {
+        "openspec": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "linkToSpecs": {
+              "type": "boolean",
+              "description": "Automatically link ADRs to OpenSpec specs",
+              "default": true
+            },
+            "updateCoordination": {
+              "type": "boolean",
+              "description": "Update coordination manifest when ADRs change",
+              "default": true
+            }
+          }
+        },
+        "beads": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "createTasks": {
+              "type": "boolean",
+              "description": "Create Beads tasks for ADR implementation",
+              "default": false
+            },
+            "linkToIssues": {
+              "type": "boolean",
+              "description": "Link ADRs to related Beads issues",
+              "default": true
+            }
+          }
+        }
+      }
+    },
+    "validation": {
+      "type": "object",
+      "description": "Validation rules for ADRs",
+      "properties": {
+        "enforceMetadata": {
+          "type": "boolean",
+          "description": "Enforce required metadata fields",
+          "default": true
+        },
+        "enforceStatus": {
+          "type": "boolean",
+          "description": "Enforce valid status values",
+          "default": true
+        },
+        "maxTitleLength": {
+          "type": "integer",
+          "description": "Maximum length for ADR titles",
+          "minimum": 10,
+          "maximum": 200,
+          "default": 100
+        },
+        "requireContext": {
+          "type": "boolean",
+          "description": "Require Context section in ADR",
+          "default": true
+        },
+        "requireDecision": {
+          "type": "boolean",
+          "description": "Require Decision section in ADR",
+          "default": true
+        },
+        "requireConsequences": {
+          "type": "boolean",
+          "description": "Require Consequences section in ADR",
+          "default": true
+        }
+      }
+    },
+    "lifecycle": {
+      "type": "object",
+      "description": "ADR lifecycle management settings",
+      "properties": {
+        "reviewSchedule": {
+          "type": "string",
+          "description": "Review schedule for ADRs (e.g., 'quarterly', 'annually')",
+          "enum": ["monthly", "quarterly", "biannually", "annually", "none"],
+          "default": "quarterly"
+        },
+        "autoSupersede": {
+          "type": "boolean",
+          "description": "Automatically mark ADRs as superseded when new ADR references them",
+          "default": false
+        },
+        "archiveSuperseded": {
+          "type": "boolean",
+          "description": "Move superseded ADRs to archive directory",
+          "default": false
+        }
+      }
+    }
+  },
+  "required": ["version", "adrDirectory", "defaultTemplate"],
+  "additionalProperties": false
+}
+

package/augment-extensions/workflows/adr-support/schemas/adr-metadata.json

@@ -0,0 +1,172 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://augment-extensions.dev/schemas/adr-metadata.json",
+  "title": "ADR Metadata Schema",
+  "description": "JSON schema for ADR frontmatter metadata validation",
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Title of the ADR",
+      "minLength": 10,
+      "maxLength": 100
+    },
+    "status": {
+      "type": "string",
+      "description": "Current status of the ADR",
+      "enum": ["draft", "proposed", "approved", "implemented", "maintained", "superseded", "sunset"]
+    },
+    "date": {
+      "type": "string",
+      "description": "Date of the ADR (ISO 8601 format)",
+      "format": "date",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+    },
+    "deciders": {
+      "type": "array",
+      "description": "List of people who made the decision",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "consulted": {
+      "type": "array",
+      "description": "List of people consulted for the decision",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "uniqueItems": true
+    },
+    "informed": {
+      "type": "array",
+      "description": "List of people informed about the decision",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "uniqueItems": true
+    },
+    "tags": {
+      "type": "array",
+      "description": "Tags for categorizing the ADR",
+      "items": {
+        "type": "string",
+        "pattern": "^[a-z0-9-]+$"
+      },
+      "uniqueItems": true
+    },
+    "supersedes": {
+      "type": "array",
+      "description": "List of ADR numbers this ADR supersedes",
+      "items": {
+        "type": "string",
+        "pattern": "^(\\d{4}|\\d{4}-\\d{2}-\\d{2})$"
+      },
+      "uniqueItems": true
+    },
+    "supersededBy": {
+      "type": "string",
+      "description": "ADR number that supersedes this ADR",
+      "pattern": "^(\\d{4}|\\d{4}-\\d{2}-\\d{2})$"
+    },
+    "relatedTo": {
+      "type": "array",
+      "description": "List of related ADR numbers",
+      "items": {
+        "type": "string",
+        "pattern": "^(\\d{4}|\\d{4}-\\d{2}-\\d{2})$"
+      },
+      "uniqueItems": true
+    },
+    "openspecSpecs": {
+      "type": "array",
+      "description": "Related OpenSpec specification files",
+      "items": {
+        "type": "string",
+        "pattern": "^openspec/specs/.*\\.md$"
+      },
+      "uniqueItems": true
+    },
+    "beadsIssues": {
+      "type": "array",
+      "description": "Related Beads issue IDs",
+      "items": {
+        "type": "string",
+        "pattern": "^bd-[a-z0-9]+(\\.\\d+)?$"
+      },
+      "uniqueItems": true
+    },
+    "implementationStatus": {
+      "type": "string",
+      "description": "Implementation status of the decision",
+      "enum": ["not-started", "in-progress", "completed", "blocked", "deferred"]
+    },
+    "reviewDate": {
+      "type": "string",
+      "description": "Next scheduled review date (ISO 8601 format)",
+      "format": "date",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+    },
+    "lastReviewed": {
+      "type": "string",
+      "description": "Date of last review (ISO 8601 format)",
+      "format": "date",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+    },
+    "impact": {
+      "type": "string",
+      "description": "Impact level of the decision",
+      "enum": ["low", "medium", "high", "critical"]
+    },
+    "scope": {
+      "type": "array",
+      "description": "Scope of the decision (e.g., components, modules affected)",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "uniqueItems": true
+    },
+    "stakeholders": {
+      "type": "array",
+      "description": "Stakeholders affected by the decision",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "uniqueItems": true
+    },
+    "technicalDebt": {
+      "type": "object",
+      "description": "Technical debt information",
+      "properties": {
+        "exists": {
+          "type": "boolean",
+          "description": "Whether this decision introduces technical debt"
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the technical debt"
+        },
+        "mitigationPlan": {
+          "type": "string",
+          "description": "Plan to address the technical debt"
+        },
+        "targetDate": {
+          "type": "string",
+          "description": "Target date to address the debt (ISO 8601 format)",
+          "format": "date",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+        }
+      },
+      "required": ["exists"]
+    }
+  },
+  "required": ["title", "status", "date", "deciders"],
+  "additionalProperties": true
+}
+

package/augment-extensions/workflows/adr-support/templates/business-case.md

@@ -0,0 +1,235 @@
+# ADR-{number}: {Title}
+
+**Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
+
+**Date:** {YYYY-MM-DD}
+
+**Deciders:** {List of people involved in the decision}
+
+**Business Owner:** {Name of business stakeholder}
+
+**Technical Story:** {Optional: Link to related issue, spec, or task}
+
+---
+
+## Executive Summary
+
+{Provide a 2-3 sentence summary of the decision, the problem it solves, and the expected business value.}
+
+---
+
+## Business Context
+
+### Problem Statement
+
+{Describe the business problem or opportunity. What pain points exist? What business goals are not being met?}
+
+### Current State
+
+{Describe the current situation, including existing solutions, workarounds, and their limitations}
+
+### Desired State
+
+{Describe the target state after implementing this decision. What will be different?}
+
+---
+
+## Strategic Alignment
+
+### Business Objectives
+
+{How does this decision align with organizational goals?}
+
+- {Objective 1}
+- {Objective 2}
+- {Objective 3}
+
+### Key Performance Indicators (KPIs)
+
+{What metrics will this decision impact?}
+
+- {KPI 1: Current value → Target value}
+- {KPI 2: Current value → Target value}
+- {KPI 3: Current value → Target value}
+
+---
+
+## Financial Analysis
+
+### Cost Breakdown
+
+#### Initial Investment
+
+| Category | Description | Cost |
+|----------|-------------|------|
+| Development | {Description} | ${amount} |
+| Infrastructure | {Description} | ${amount} |
+| Licensing | {Description} | ${amount} |
+| Training | {Description} | ${amount} |
+| **Total Initial** | | **${total}** |
+
+#### Ongoing Costs (Annual)
+
+| Category | Description | Cost |
+|----------|-------------|------|
+| Maintenance | {Description} | ${amount}/year |
+| Support | {Description} | ${amount}/year |
+| Licensing | {Description} | ${amount}/year |
+| Infrastructure | {Description} | ${amount}/year |
+| **Total Annual** | | **${total}/year** |
+
+### Return on Investment (ROI)
+
+#### Expected Benefits (Annual)
+
+| Benefit | Description | Value |
+|---------|-------------|-------|
+| Revenue Increase | {Description} | ${amount}/year |
+| Cost Savings | {Description} | ${amount}/year |
+| Efficiency Gains | {Description} | ${amount}/year |
+| **Total Annual Benefit** | | **${total}/year** |
+
+#### ROI Calculation
+
+- **Total Initial Investment:** ${amount}
+- **Annual Net Benefit:** ${annual benefit - annual cost}
+- **Payback Period:** {X months/years}
+- **3-Year ROI:** {percentage}%
+- **5-Year ROI:** {percentage}%
+
+### Risk-Adjusted ROI
+
+{Consider risks and their probability/impact on ROI}
+
+- **Best Case:** {ROI percentage}%
+- **Expected Case:** {ROI percentage}%
+- **Worst Case:** {ROI percentage}%
+
+---
+
+## Risk Assessment
+
+### Business Risks
+
+| Risk | Probability | Impact | Mitigation Strategy |
+|------|-------------|--------|---------------------|
+| {Risk 1} | {Low/Med/High} | {Low/Med/High} | {Strategy} |
+| {Risk 2} | {Low/Med/High} | {Low/Med/High} | {Strategy} |
+| {Risk 3} | {Low/Med/High} | {Low/Med/High} | {Strategy} |
+
+### Technical Risks
+
+| Risk | Probability | Impact | Mitigation Strategy |
+|------|-------------|--------|---------------------|
+| {Risk 1} | {Low/Med/High} | {Low/Med/High} | {Strategy} |
+| {Risk 2} | {Low/Med/High} | {Low/Med/High} | {Strategy} |
+
+---
+
+## Alternatives Considered
+
+### Option 1: {Option Name}
+
+**Cost:** ${amount}
+**ROI:** {percentage}%
+**Pros:** {Brief list}
+**Cons:** {Brief list}
+**Why not chosen:** {Reason}
+
+### Option 2: {Option Name}
+
+**Cost:** ${amount}
+**ROI:** {percentage}%
+**Pros:** {Brief list}
+**Cons:** {Brief list}
+**Why not chosen:** {Reason}
+
+### Option 3: Do Nothing
+
+**Cost:** ${opportunity cost}
+**Impact:** {Description of impact of not acting}
+**Why not chosen:** {Reason}
+
+---
+
+## Decision Outcome
+
+**Chosen option:** "{Option X}"
+
+### Justification
+
+{Explain why this option provides the best business value, considering costs, benefits, risks, and strategic alignment}
+
+### Success Criteria
+
+{How will we measure success?}
+
+- {Criterion 1}
+- {Criterion 2}
+- {Criterion 3}
+
+---
+
+## Implementation Timeline
+
+| Phase | Duration | Key Milestones | Cost |
+|-------|----------|----------------|------|
+| Phase 1: {Name} | {X weeks} | {Milestones} | ${amount} |
+| Phase 2: {Name} | {X weeks} | {Milestones} | ${amount} |
+| Phase 3: {Name} | {X weeks} | {Milestones} | ${amount} |
+
+**Total Duration:** {X months}
+
+---
+
+## Stakeholder Impact
+
+### Internal Stakeholders
+
+| Stakeholder | Impact | Change Required | Support Level |
+|-------------|--------|-----------------|---------------|
+| {Team/Dept} | {Description} | {Changes needed} | {High/Med/Low} |
+| {Team/Dept} | {Description} | {Changes needed} | {High/Med/Low} |
+
+### External Stakeholders
+
+| Stakeholder | Impact | Communication Plan |
+|-------------|--------|--------------------|
+| {Customers} | {Description} | {Plan} |
+| {Partners} | {Description} | {Plan} |
+
+---
+
+## Approval
+
+### Recommendation
+
+{Clear recommendation with supporting rationale}
+
+### Required Approvals
+
+- [ ] {Business Owner}
+- [ ] {Finance}
+- [ ] {Technical Lead}
+- [ ] {Executive Sponsor}
+
+### Approval Date
+
+{Date when decision was approved}
+
+---
+
+## More Information
+
+### References
+
+- {Link to market research}
+- {Link to competitive analysis}
+- {Link to technical feasibility study}
+
+### Appendices
+
+- {Link to detailed financial model}
+- {Link to risk analysis}
+- {Link to stakeholder analysis}
+