musubix 2.4.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -310
- package/bin/musubix.js +1 -9
- package/dist/index.d.ts +25 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +74 -0
- package/dist/index.js.map +1 -0
- package/package.json +51 -72
- package/.github/AGENTS.md +0 -242
- package/.github/prompts/sdd-change-apply.prompt.md +0 -283
- package/.github/prompts/sdd-change-archive.prompt.md +0 -241
- package/.github/prompts/sdd-change-init.prompt.md +0 -269
- package/.github/prompts/sdd-design.prompt.md +0 -250
- package/.github/prompts/sdd-implement.prompt.md +0 -387
- package/.github/prompts/sdd-requirements.prompt.md +0 -193
- package/.github/prompts/sdd-review.prompt.md +0 -155
- package/.github/prompts/sdd-security.prompt.md +0 -228
- package/.github/prompts/sdd-steering.prompt.md +0 -269
- package/.github/prompts/sdd-tasks.prompt.md +0 -255
- package/.github/prompts/sdd-test.prompt.md +0 -230
- package/.github/prompts/sdd-validate.prompt.md +0 -304
- package/.github/skills/musubix-adr-generation/SKILL.md +0 -209
- package/.github/skills/musubix-best-practices/SKILL.md +0 -315
- package/.github/skills/musubix-c4-design/SKILL.md +0 -162
- package/.github/skills/musubix-code-generation/SKILL.md +0 -229
- package/.github/skills/musubix-domain-inference/SKILL.md +0 -196
- package/.github/skills/musubix-ears-validation/SKILL.md +0 -161
- package/.github/skills/musubix-sdd-workflow/SKILL.md +0 -210
- package/.github/skills/musubix-technical-writing/SKILL.md +0 -444
- package/.github/skills/musubix-test-generation/SKILL.md +0 -212
- package/.github/skills/musubix-traceability/SKILL.md +0 -141
- package/AGENTS.md +0 -772
- package/LICENSE +0 -21
- package/README.ja.md +0 -302
- package/bin/musubix-mcp.js +0 -15
- package/docs/API-REFERENCE.md +0 -1425
- package/docs/GITHUB-ACTIONS-NPM-SETUP.md +0 -132
- package/docs/INSTALL-GUIDE.ja.md +0 -459
- package/docs/INSTALL-GUIDE.md +0 -459
- package/docs/MUSUBI-enhancement_roadmap_20260105.md +0 -651
- package/docs/MUSUBIXv2.2.0-Manual-outline.md +0 -136
- package/docs/MUSUBIXv2.2.0-Manual.md +0 -3123
- package/docs/MUSUBIXv2.3.5-Refactering.md +0 -1310
- package/docs/MUSUBIv1.6.1-enhancement_roadmap_20260105.md +0 -291
- package/docs/MUSUBIv2.2.0-USERGUIDE.md +0 -2079
- package/docs/ROADMAP-v1.5.md +0 -116
- package/docs/SwarmCoding.md +0 -1284
- package/docs/Test-prompt.md +0 -105
- package/docs/USER-GUIDE-v1.8.0.md +0 -2371
- package/docs/USER-GUIDE.ja.md +0 -2147
- package/docs/USER-GUIDE.md +0 -2847
- package/docs/adr/0001-real-time-pattern-learning-architecture-for-v1-5-0.md +0 -75
- package/docs/adr/0002-pattern-sharing-protocol-for-cross-team-collaborat.md +0 -79
- package/docs/adr/0003-owl-2-rl-implementation-strategy-for-advanced-infe.md +0 -90
- package/docs/evolution-from-musubi-to-musubix.md +0 -2170
- package/docs/getting-started-with-sdd.md +0 -1602
- package/docs/moodle-refactering-codegraph-musubix.md +0 -391
- package/docs/moodle-refactering-codegraph.md +0 -278
- package/docs/overview/MUSUBIX-CodeGraph.md +0 -322
- package/docs/overview/MUSUBIX-Core.md +0 -671
- package/docs/overview/MUSUBIX-FormalVerify.md +0 -566
- package/docs/overview/MUSUBIX-Learning.md +0 -837
- package/docs/overview/MUSUBIX-MCP-Server.md +0 -535
- package/docs/overview/MUSUBIX-Overview.md +0 -264
- package/docs/overview/MUSUBIX-Phase1-Complete.md +0 -271
- package/docs/overview/MUSUBIX-Phase2-Complete.md +0 -310
- package/docs/overview/MUSUBIX-Roadmap-v2.md +0 -399
- package/docs/overview/MUSUBIX-Security-Plan.md +0 -939
- package/docs/overview/MUSUBIX-Security-v2.1.md +0 -668
- package/docs/overview/MUSUBIX-Security.md +0 -891
- package/docs/overview/MUSUBIX-YATA.md +0 -666
- package/docs/overview/MUSUBIX-v2.2.0-Advanced-Learning.md +0 -513
- package/docs/overview/Neuro-SymbolicAI.md +0 -159
- package/scripts/generate-quality-gate-report.ts +0 -106
- package/scripts/postinstall.js +0 -94
- package/steering/.musubi-version +0 -1
- package/steering/product.ja.md +0 -572
- package/steering/project.yml +0 -66
- package/steering/rules/constitution.md +0 -412
- package/steering/structure.ja.md +0 -503
- package/steering/tech.ja.md +0 -208
|
@@ -1,210 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: musubix-sdd-workflow
|
|
3
|
-
description: Guide for MUSUBIX SDD (Specification-Driven Development) workflow. Use this when asked to develop features using MUSUBIX methodology, create requirements, designs, or implement code following the 9 constitutional articles.
|
|
4
|
-
license: MIT
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# MUSUBIX SDD Workflow Skill
|
|
8
|
-
|
|
9
|
-
This skill guides you through the complete SDD workflow for MUSUBIX projects.
|
|
10
|
-
|
|
11
|
-
## Prerequisites
|
|
12
|
-
|
|
13
|
-
Before starting any development task:
|
|
14
|
-
|
|
15
|
-
1. Read `steering/` directory for project context
|
|
16
|
-
2. Check `steering/rules/constitution.md` for the 9 constitutional articles
|
|
17
|
-
3. Review existing specs in `storage/specs/`
|
|
18
|
-
|
|
19
|
-
## Complete Workflow
|
|
20
|
-
|
|
21
|
-
### Phase 1: Requirements Definition
|
|
22
|
-
|
|
23
|
-
#### Step 1: Create Requirements Document (Article IV - EARS Format)
|
|
24
|
-
|
|
25
|
-
Create requirements using EARS patterns:
|
|
26
|
-
|
|
27
|
-
```markdown
|
|
28
|
-
# REQ-[CATEGORY]-[NUMBER]
|
|
29
|
-
|
|
30
|
-
**種別**: [UBIQUITOUS|EVENT-DRIVEN|STATE-DRIVEN|UNWANTED|OPTIONAL]
|
|
31
|
-
**優先度**: [P0|P1|P2]
|
|
32
|
-
|
|
33
|
-
**要件**:
|
|
34
|
-
[EARS形式の要件文]
|
|
35
|
-
|
|
36
|
-
**トレーサビリティ**: DES-XXX, TEST-XXX
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
EARS Patterns:
|
|
40
|
-
- **Ubiquitous**: `THE [system] SHALL [requirement]`
|
|
41
|
-
- **Event-driven**: `WHEN [event], THE [system] SHALL [response]`
|
|
42
|
-
- **State-driven**: `WHILE [state], THE [system] SHALL [response]`
|
|
43
|
-
- **Unwanted**: `THE [system] SHALL NOT [behavior]`
|
|
44
|
-
- **Optional**: `IF [condition], THEN THE [system] SHALL [response]`
|
|
45
|
-
|
|
46
|
-
#### Step 2-3: Requirements Review Loop
|
|
47
|
-
|
|
48
|
-
Review requirements for:
|
|
49
|
-
- EARS format compliance
|
|
50
|
-
- Completeness and clarity
|
|
51
|
-
- Testability
|
|
52
|
-
- Traceability readiness
|
|
53
|
-
|
|
54
|
-
**Repeat until no issues remain.**
|
|
55
|
-
|
|
56
|
-
### Phase 2: Design
|
|
57
|
-
|
|
58
|
-
#### Step 4: Create Design Document (Article VII - Design Patterns)
|
|
59
|
-
|
|
60
|
-
Create C4 model design documents:
|
|
61
|
-
|
|
62
|
-
1. **Context Level**: System boundaries and external actors
|
|
63
|
-
2. **Container Level**: Technology choices and container composition
|
|
64
|
-
3. **Component Level**: Internal structure of containers
|
|
65
|
-
4. **Code Level**: Implementation details
|
|
66
|
-
|
|
67
|
-
Design document template:
|
|
68
|
-
```markdown
|
|
69
|
-
# DES-[CATEGORY]-[NUMBER]
|
|
70
|
-
|
|
71
|
-
## トレーサビリティ
|
|
72
|
-
- 要件: REQ-XXX
|
|
73
|
-
|
|
74
|
-
## C4モデル
|
|
75
|
-
### Level 2: Container
|
|
76
|
-
[PlantUML diagram]
|
|
77
|
-
|
|
78
|
-
## コンポーネント設計
|
|
79
|
-
[Component details]
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
#### Step 5-6: Design Review Loop
|
|
83
|
-
|
|
84
|
-
Review design for:
|
|
85
|
-
- Requirement coverage
|
|
86
|
-
- SOLID principles compliance
|
|
87
|
-
- Design pattern appropriateness
|
|
88
|
-
- Traceability to requirements
|
|
89
|
-
|
|
90
|
-
**Repeat until no issues remain.**
|
|
91
|
-
|
|
92
|
-
### Phase 3: Task Decomposition
|
|
93
|
-
|
|
94
|
-
#### Step 7: Generate Tasks
|
|
95
|
-
|
|
96
|
-
Generate implementation tasks from design:
|
|
97
|
-
|
|
98
|
-
```markdown
|
|
99
|
-
# TSK-[CATEGORY]-[NUMBER]
|
|
100
|
-
|
|
101
|
-
## 関連設計: DES-XXX
|
|
102
|
-
## 関連要件: REQ-XXX
|
|
103
|
-
|
|
104
|
-
## タスク内容
|
|
105
|
-
[Implementation task description]
|
|
106
|
-
|
|
107
|
-
## 受入基準
|
|
108
|
-
- [ ] Criterion 1
|
|
109
|
-
- [ ] Criterion 2
|
|
110
|
-
|
|
111
|
-
## 見積もり
|
|
112
|
-
[4時間以内を推奨]
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
#### Step 8-9: Task Review Loop
|
|
116
|
-
|
|
117
|
-
Review tasks for:
|
|
118
|
-
- Appropriate granularity (≤4 hours)
|
|
119
|
-
- Clear acceptance criteria
|
|
120
|
-
- Complete traceability chain
|
|
121
|
-
|
|
122
|
-
**Repeat until no issues remain.**
|
|
123
|
-
|
|
124
|
-
### Phase 4: Implementation
|
|
125
|
-
|
|
126
|
-
#### Step 10: Coding & Unit Testing (Article III - Test-First)
|
|
127
|
-
|
|
128
|
-
For each task, follow Red-Green-Blue cycle:
|
|
129
|
-
|
|
130
|
-
1. **Red**: Write failing test first
|
|
131
|
-
2. **Green**: Write minimal code to pass
|
|
132
|
-
3. **Blue**: Refactor while keeping tests green
|
|
133
|
-
|
|
134
|
-
Add requirement IDs in code comments:
|
|
135
|
-
```typescript
|
|
136
|
-
/**
|
|
137
|
-
* @see REQ-INT-001 - Neuro-Symbolic Integration
|
|
138
|
-
*/
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
#### Step 11: Integration Testing
|
|
142
|
-
|
|
143
|
-
When required by the task:
|
|
144
|
-
- Run integration tests
|
|
145
|
-
- Verify component interactions
|
|
146
|
-
- Ensure end-to-end flows work correctly
|
|
147
|
-
|
|
148
|
-
### Phase 5: Documentation & Completion
|
|
149
|
-
|
|
150
|
-
#### Step 12: Update CHANGELOG.md
|
|
151
|
-
|
|
152
|
-
Document all changes:
|
|
153
|
-
- New features
|
|
154
|
-
- Bug fixes
|
|
155
|
-
- Breaking changes
|
|
156
|
-
- Migration notes
|
|
157
|
-
|
|
158
|
-
#### Step 13: Update Other Documentation
|
|
159
|
-
|
|
160
|
-
If necessary, update:
|
|
161
|
-
- README.md
|
|
162
|
-
- USER-GUIDE.md
|
|
163
|
-
- API-REFERENCE.md
|
|
164
|
-
- AGENTS.md
|
|
165
|
-
|
|
166
|
-
#### Step 14: Git Commit & Push
|
|
167
|
-
|
|
168
|
-
```bash
|
|
169
|
-
git add .
|
|
170
|
-
git commit -m "feat/fix/chore: description"
|
|
171
|
-
git push
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
## Traceability Validation (Article V)
|
|
175
|
-
|
|
176
|
-
Ensure 100% traceability throughout:
|
|
177
|
-
```
|
|
178
|
-
REQ-* → DES-* → TSK-* → Code → Test
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
## CLI Commands
|
|
182
|
-
|
|
183
|
-
```bash
|
|
184
|
-
# Requirements
|
|
185
|
-
npx musubix requirements analyze <file>
|
|
186
|
-
npx musubix requirements validate <file>
|
|
187
|
-
|
|
188
|
-
# Design
|
|
189
|
-
npx musubix design generate <file>
|
|
190
|
-
npx musubix design patterns <context>
|
|
191
|
-
|
|
192
|
-
# Code Generation
|
|
193
|
-
npx musubix codegen generate <file>
|
|
194
|
-
|
|
195
|
-
# Traceability
|
|
196
|
-
npx musubix trace matrix
|
|
197
|
-
npx musubix trace validate
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
## Constitutional Articles Checklist
|
|
201
|
-
|
|
202
|
-
- [ ] **Article I**: Library-First - Is this a standalone library?
|
|
203
|
-
- [ ] **Article II**: CLI Interface - Does it expose CLI?
|
|
204
|
-
- [ ] **Article III**: Test-First - Are tests written first?
|
|
205
|
-
- [ ] **Article IV**: EARS Format - Are requirements in EARS?
|
|
206
|
-
- [ ] **Article V**: Traceability - Is everything traceable?
|
|
207
|
-
- [ ] **Article VI**: Project Memory - Did you check steering/?
|
|
208
|
-
- [ ] **Article VII**: Design Patterns - Are patterns documented?
|
|
209
|
-
- [ ] **Article VIII**: Decision Records - Is ADR created?
|
|
210
|
-
- [ ] **Article IX**: Quality Gates - Are quality checks passed?
|
|
@@ -1,444 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: musubix-technical-writing
|
|
3
|
-
description: Guide for creating technical documentation including README, user guides, API references, and changelogs. Use this when asked to write documentation, create user manuals, or generate API docs.
|
|
4
|
-
license: MIT
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# MUSUBIX Technical Writing Skill
|
|
8
|
-
|
|
9
|
-
This skill guides you through creating high-quality technical documentation for software projects.
|
|
10
|
-
|
|
11
|
-
## Overview
|
|
12
|
-
|
|
13
|
-
Technical documentation bridges the gap between code and users. MUSUBIX supports generating various document types with consistent structure and traceability.
|
|
14
|
-
|
|
15
|
-
## Document Types
|
|
16
|
-
|
|
17
|
-
### 1. README.md (Project Overview)
|
|
18
|
-
|
|
19
|
-
**Purpose**: First impression of your project.
|
|
20
|
-
|
|
21
|
-
**Template**:
|
|
22
|
-
```markdown
|
|
23
|
-
# Project Name
|
|
24
|
-
|
|
25
|
-
> One-line description of what the project does.
|
|
26
|
-
|
|
27
|
-
[](https://badge.fury.io/js/package-name)
|
|
28
|
-
[](https://opensource.org/licenses/MIT)
|
|
29
|
-
|
|
30
|
-
## 🎯 Features
|
|
31
|
-
|
|
32
|
-
- Feature 1: Brief description
|
|
33
|
-
- Feature 2: Brief description
|
|
34
|
-
- Feature 3: Brief description
|
|
35
|
-
|
|
36
|
-
## 📦 Installation
|
|
37
|
-
|
|
38
|
-
\`\`\`bash
|
|
39
|
-
npm install package-name
|
|
40
|
-
\`\`\`
|
|
41
|
-
|
|
42
|
-
## 🚀 Quick Start
|
|
43
|
-
|
|
44
|
-
\`\`\`typescript
|
|
45
|
-
import { MainClass } from 'package-name';
|
|
46
|
-
|
|
47
|
-
const instance = new MainClass();
|
|
48
|
-
instance.doSomething();
|
|
49
|
-
\`\`\`
|
|
50
|
-
|
|
51
|
-
## 📖 Documentation
|
|
52
|
-
|
|
53
|
-
- [Installation Guide](docs/INSTALL-GUIDE.md)
|
|
54
|
-
- [User Guide](docs/USER-GUIDE.md)
|
|
55
|
-
- [API Reference](docs/API-REFERENCE.md)
|
|
56
|
-
|
|
57
|
-
## 🤝 Contributing
|
|
58
|
-
|
|
59
|
-
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
60
|
-
|
|
61
|
-
## 📄 License
|
|
62
|
-
|
|
63
|
-
MIT License - see [LICENSE](LICENSE) for details.
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### 2. INSTALL-GUIDE.md (Installation Guide)
|
|
67
|
-
|
|
68
|
-
**Purpose**: Step-by-step setup instructions.
|
|
69
|
-
|
|
70
|
-
**Structure**:
|
|
71
|
-
```markdown
|
|
72
|
-
# Installation Guide
|
|
73
|
-
|
|
74
|
-
## Prerequisites
|
|
75
|
-
|
|
76
|
-
| Requirement | Version | Check Command |
|
|
77
|
-
|-------------|---------|---------------|
|
|
78
|
-
| Node.js | >= 20.0.0 | `node --version` |
|
|
79
|
-
| npm | >= 10.0.0 | `npm --version` |
|
|
80
|
-
|
|
81
|
-
## Installation Methods
|
|
82
|
-
|
|
83
|
-
### Method 1: npm (Recommended)
|
|
84
|
-
|
|
85
|
-
\`\`\`bash
|
|
86
|
-
npm install package-name
|
|
87
|
-
\`\`\`
|
|
88
|
-
|
|
89
|
-
### Method 2: From Source
|
|
90
|
-
|
|
91
|
-
\`\`\`bash
|
|
92
|
-
git clone https://github.com/user/repo.git
|
|
93
|
-
cd repo
|
|
94
|
-
npm install
|
|
95
|
-
npm run build
|
|
96
|
-
\`\`\`
|
|
97
|
-
|
|
98
|
-
## Configuration
|
|
99
|
-
|
|
100
|
-
### Environment Variables
|
|
101
|
-
|
|
102
|
-
| Variable | Description | Default |
|
|
103
|
-
|----------|-------------|---------|
|
|
104
|
-
| `API_KEY` | API authentication key | - |
|
|
105
|
-
| `LOG_LEVEL` | Logging verbosity | `info` |
|
|
106
|
-
|
|
107
|
-
### Configuration File
|
|
108
|
-
|
|
109
|
-
Create `config.json`:
|
|
110
|
-
\`\`\`json
|
|
111
|
-
{
|
|
112
|
-
"setting1": "value1",
|
|
113
|
-
"setting2": true
|
|
114
|
-
}
|
|
115
|
-
\`\`\`
|
|
116
|
-
|
|
117
|
-
## Verification
|
|
118
|
-
|
|
119
|
-
\`\`\`bash
|
|
120
|
-
npx package-name --version
|
|
121
|
-
\`\`\`
|
|
122
|
-
|
|
123
|
-
## Troubleshooting
|
|
124
|
-
|
|
125
|
-
### Common Issues
|
|
126
|
-
|
|
127
|
-
#### Issue: Module not found
|
|
128
|
-
**Solution**: Run `npm install` again.
|
|
129
|
-
|
|
130
|
-
#### Issue: Permission denied
|
|
131
|
-
**Solution**: Use `sudo` or fix npm permissions.
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### 3. USER-GUIDE.md (User Guide)
|
|
135
|
-
|
|
136
|
-
**Purpose**: Comprehensive usage instructions.
|
|
137
|
-
|
|
138
|
-
**Structure**:
|
|
139
|
-
```markdown
|
|
140
|
-
# User Guide
|
|
141
|
-
|
|
142
|
-
## Table of Contents
|
|
143
|
-
|
|
144
|
-
1. [Getting Started](#getting-started)
|
|
145
|
-
2. [Basic Usage](#basic-usage)
|
|
146
|
-
3. [Advanced Features](#advanced-features)
|
|
147
|
-
4. [Best Practices](#best-practices)
|
|
148
|
-
|
|
149
|
-
## Getting Started
|
|
150
|
-
|
|
151
|
-
### Your First Project
|
|
152
|
-
|
|
153
|
-
1. Create a new directory
|
|
154
|
-
2. Initialize the project
|
|
155
|
-
3. Run your first command
|
|
156
|
-
|
|
157
|
-
## Basic Usage
|
|
158
|
-
|
|
159
|
-
### Command: `command-name`
|
|
160
|
-
|
|
161
|
-
**Syntax**:
|
|
162
|
-
\`\`\`bash
|
|
163
|
-
npx tool command [options] <arguments>
|
|
164
|
-
\`\`\`
|
|
165
|
-
|
|
166
|
-
**Options**:
|
|
167
|
-
| Option | Short | Description |
|
|
168
|
-
|--------|-------|-------------|
|
|
169
|
-
| `--output` | `-o` | Output directory |
|
|
170
|
-
| `--verbose` | `-v` | Enable verbose logging |
|
|
171
|
-
|
|
172
|
-
**Examples**:
|
|
173
|
-
\`\`\`bash
|
|
174
|
-
# Basic usage
|
|
175
|
-
npx tool command input.txt
|
|
176
|
-
|
|
177
|
-
# With options
|
|
178
|
-
npx tool command -o output/ -v input.txt
|
|
179
|
-
\`\`\`
|
|
180
|
-
|
|
181
|
-
## Advanced Features
|
|
182
|
-
|
|
183
|
-
### Feature: Custom Configuration
|
|
184
|
-
|
|
185
|
-
[Detailed explanation with examples]
|
|
186
|
-
|
|
187
|
-
## Best Practices
|
|
188
|
-
|
|
189
|
-
1. **Do**: Recommended approach
|
|
190
|
-
2. **Don't**: Anti-pattern to avoid
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
### 4. API-REFERENCE.md (API Reference)
|
|
194
|
-
|
|
195
|
-
**Purpose**: Complete API documentation.
|
|
196
|
-
|
|
197
|
-
**Structure**:
|
|
198
|
-
```markdown
|
|
199
|
-
# API Reference
|
|
200
|
-
|
|
201
|
-
## Classes
|
|
202
|
-
|
|
203
|
-
### `ClassName`
|
|
204
|
-
|
|
205
|
-
Description of the class.
|
|
206
|
-
|
|
207
|
-
#### Constructor
|
|
208
|
-
|
|
209
|
-
\`\`\`typescript
|
|
210
|
-
new ClassName(options?: ClassOptions)
|
|
211
|
-
\`\`\`
|
|
212
|
-
|
|
213
|
-
| Parameter | Type | Description |
|
|
214
|
-
|-----------|------|-------------|
|
|
215
|
-
| `options` | `ClassOptions` | Configuration options |
|
|
216
|
-
|
|
217
|
-
#### Methods
|
|
218
|
-
|
|
219
|
-
##### `methodName(param1, param2)`
|
|
220
|
-
|
|
221
|
-
Description of what the method does.
|
|
222
|
-
|
|
223
|
-
**Parameters**:
|
|
224
|
-
| Name | Type | Required | Description |
|
|
225
|
-
|------|------|----------|-------------|
|
|
226
|
-
| `param1` | `string` | Yes | First parameter |
|
|
227
|
-
| `param2` | `number` | No | Optional second parameter |
|
|
228
|
-
|
|
229
|
-
**Returns**: `Promise<Result>`
|
|
230
|
-
|
|
231
|
-
**Example**:
|
|
232
|
-
\`\`\`typescript
|
|
233
|
-
const result = await instance.methodName('value', 42);
|
|
234
|
-
\`\`\`
|
|
235
|
-
|
|
236
|
-
**Throws**:
|
|
237
|
-
- `ValidationError`: When param1 is empty
|
|
238
|
-
|
|
239
|
-
## Interfaces
|
|
240
|
-
|
|
241
|
-
### `InterfaceName`
|
|
242
|
-
|
|
243
|
-
\`\`\`typescript
|
|
244
|
-
interface InterfaceName {
|
|
245
|
-
property1: string;
|
|
246
|
-
property2?: number;
|
|
247
|
-
method(arg: string): void;
|
|
248
|
-
}
|
|
249
|
-
\`\`\`
|
|
250
|
-
|
|
251
|
-
## Types
|
|
252
|
-
|
|
253
|
-
### `TypeName`
|
|
254
|
-
|
|
255
|
-
\`\`\`typescript
|
|
256
|
-
type TypeName = 'option1' | 'option2' | 'option3';
|
|
257
|
-
\`\`\`
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
### 5. CHANGELOG.md (Change Log)
|
|
261
|
-
|
|
262
|
-
**Purpose**: Track version history.
|
|
263
|
-
|
|
264
|
-
**Format**: Follow [Keep a Changelog](https://keepachangelog.com/)
|
|
265
|
-
|
|
266
|
-
```markdown
|
|
267
|
-
# Changelog
|
|
268
|
-
|
|
269
|
-
All notable changes to this project will be documented in this file.
|
|
270
|
-
|
|
271
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
272
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
273
|
-
|
|
274
|
-
## [Unreleased]
|
|
275
|
-
|
|
276
|
-
### Added
|
|
277
|
-
- New feature description
|
|
278
|
-
|
|
279
|
-
### Changed
|
|
280
|
-
- Modified behavior description
|
|
281
|
-
|
|
282
|
-
### Deprecated
|
|
283
|
-
- Feature to be removed in future
|
|
284
|
-
|
|
285
|
-
### Removed
|
|
286
|
-
- Deleted feature description
|
|
287
|
-
|
|
288
|
-
### Fixed
|
|
289
|
-
- Bug fix description
|
|
290
|
-
|
|
291
|
-
### Security
|
|
292
|
-
- Security fix description
|
|
293
|
-
|
|
294
|
-
## [1.0.0] - 2026-01-10
|
|
295
|
-
|
|
296
|
-
### Added
|
|
297
|
-
- Initial release
|
|
298
|
-
- Core functionality
|
|
299
|
-
- CLI interface
|
|
300
|
-
```
|
|
301
|
-
|
|
302
|
-
### 6. CONTRIBUTING.md (Contributing Guide)
|
|
303
|
-
|
|
304
|
-
**Purpose**: Guide for contributors.
|
|
305
|
-
|
|
306
|
-
```markdown
|
|
307
|
-
# Contributing Guide
|
|
308
|
-
|
|
309
|
-
Thank you for your interest in contributing!
|
|
310
|
-
|
|
311
|
-
## Development Setup
|
|
312
|
-
|
|
313
|
-
1. Fork the repository
|
|
314
|
-
2. Clone your fork
|
|
315
|
-
3. Install dependencies: `npm install`
|
|
316
|
-
4. Create a branch: `git checkout -b feature/your-feature`
|
|
317
|
-
|
|
318
|
-
## Code Standards
|
|
319
|
-
|
|
320
|
-
- Use TypeScript
|
|
321
|
-
- Follow ESLint rules
|
|
322
|
-
- Write tests for new features
|
|
323
|
-
- Maintain 80%+ code coverage
|
|
324
|
-
|
|
325
|
-
## Pull Request Process
|
|
326
|
-
|
|
327
|
-
1. Update documentation
|
|
328
|
-
2. Add tests
|
|
329
|
-
3. Run `npm test`
|
|
330
|
-
4. Submit PR with clear description
|
|
331
|
-
|
|
332
|
-
## Commit Message Format
|
|
333
|
-
|
|
334
|
-
\`\`\`
|
|
335
|
-
type(scope): description
|
|
336
|
-
|
|
337
|
-
[optional body]
|
|
338
|
-
|
|
339
|
-
[optional footer]
|
|
340
|
-
\`\`\`
|
|
341
|
-
|
|
342
|
-
Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
|
|
343
|
-
|
|
344
|
-
## Code of Conduct
|
|
345
|
-
|
|
346
|
-
Be respectful and inclusive.
|
|
347
|
-
```
|
|
348
|
-
|
|
349
|
-
## Writing Guidelines
|
|
350
|
-
|
|
351
|
-
### 1. Audience-Aware Writing
|
|
352
|
-
|
|
353
|
-
| Document | Audience | Tone | Technical Level |
|
|
354
|
-
|----------|----------|------|-----------------|
|
|
355
|
-
| README | Everyone | Welcoming | Low-Medium |
|
|
356
|
-
| INSTALL-GUIDE | Users | Instructive | Medium |
|
|
357
|
-
| USER-GUIDE | Users | Explanatory | Medium |
|
|
358
|
-
| API-REFERENCE | Developers | Technical | High |
|
|
359
|
-
| CONTRIBUTING | Contributors | Collaborative | High |
|
|
360
|
-
|
|
361
|
-
### 2. Formatting Best Practices
|
|
362
|
-
|
|
363
|
-
```markdown
|
|
364
|
-
# ✅ Good Practices
|
|
365
|
-
|
|
366
|
-
## Use Clear Headings
|
|
367
|
-
Structure content hierarchically.
|
|
368
|
-
|
|
369
|
-
## Include Code Examples
|
|
370
|
-
\`\`\`typescript
|
|
371
|
-
// Always show working examples
|
|
372
|
-
const example = 'value';
|
|
373
|
-
\`\`\`
|
|
374
|
-
|
|
375
|
-
## Use Tables for Structured Data
|
|
376
|
-
| Column 1 | Column 2 |
|
|
377
|
-
|----------|----------|
|
|
378
|
-
| Data | Data |
|
|
379
|
-
|
|
380
|
-
## Add Visual Cues
|
|
381
|
-
> 💡 **Tip**: Helpful advice
|
|
382
|
-
> ⚠️ **Warning**: Important caution
|
|
383
|
-
> ❌ **Error**: Common mistake
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
### 3. Multilingual Support
|
|
387
|
-
|
|
388
|
-
For projects requiring Japanese and English:
|
|
389
|
-
|
|
390
|
-
```
|
|
391
|
-
docs/
|
|
392
|
-
├── README.md # English (default)
|
|
393
|
-
├── README.ja.md # Japanese
|
|
394
|
-
├── USER-GUIDE.md # English
|
|
395
|
-
├── USER-GUIDE.ja.md # Japanese
|
|
396
|
-
└── ...
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
## CLI Integration
|
|
400
|
-
|
|
401
|
-
```bash
|
|
402
|
-
# Generate README from project analysis
|
|
403
|
-
npx musubix docs readme
|
|
404
|
-
|
|
405
|
-
# Generate API reference from TypeScript
|
|
406
|
-
npx musubix docs api --source src/
|
|
407
|
-
|
|
408
|
-
# Update CHANGELOG from git commits
|
|
409
|
-
npx musubix docs changelog --from v1.0.0
|
|
410
|
-
|
|
411
|
-
# Generate all documentation
|
|
412
|
-
npx musubix docs generate --all
|
|
413
|
-
```
|
|
414
|
-
|
|
415
|
-
## Traceability
|
|
416
|
-
|
|
417
|
-
Link documentation to requirements and design:
|
|
418
|
-
|
|
419
|
-
```markdown
|
|
420
|
-
<!-- @requirement REQ-DOC-001 -->
|
|
421
|
-
<!-- @design DES-DOC-001 -->
|
|
422
|
-
|
|
423
|
-
# User Guide
|
|
424
|
-
|
|
425
|
-
This guide covers the usage of...
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
## Document Quality Checklist
|
|
429
|
-
|
|
430
|
-
- [ ] Clear purpose statement
|
|
431
|
-
- [ ] Logical structure with headings
|
|
432
|
-
- [ ] Working code examples
|
|
433
|
-
- [ ] Complete parameter documentation
|
|
434
|
-
- [ ] Error handling examples
|
|
435
|
-
- [ ] Up-to-date with current version
|
|
436
|
-
- [ ] Spell-checked and grammar-checked
|
|
437
|
-
- [ ] Links verified
|
|
438
|
-
- [ ] Screenshots/diagrams where helpful
|
|
439
|
-
|
|
440
|
-
## Related Skills
|
|
441
|
-
|
|
442
|
-
- [musubix-sdd-workflow](../musubix-sdd-workflow/SKILL.md) - Overall development workflow
|
|
443
|
-
- [musubix-adr-generation](../musubix-adr-generation/SKILL.md) - Decision documentation
|
|
444
|
-
- [musubix-code-generation](../musubix-code-generation/SKILL.md) - Code with doc comments
|