aiwf 0.3.0 β 0.3.1
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/CHANGELOG.md +38 -36
- package/CLAUDE.md +8 -209
- package/README.md +25 -5
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_docs.md +225 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_status.md +246 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_code_review.md +62 -62
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_commit.md +111 -111
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_general_task.md +106 -106
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_milestone_plan.md +127 -127
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +130 -130
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +87 -87
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_do_task.md +72 -72
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_docs.md +225 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_initialize.md +86 -86
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_issue_create.md +3 -3
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_status.md +246 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_pr_create.md +14 -14
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime.md +5 -5
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_project_review.md +39 -39
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_test.md +76 -77
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_testing_review.md +120 -120
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_general.md +209 -266
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_yolo.md +226 -226
- package/docs/AI-WORKFLOW.ko.md +9 -2
- package/docs/AI-WORKFLOW.md +9 -2
- package/docs/COMMANDS_GUIDE.ko.md +93 -3
- package/docs/COMMANDS_GUIDE.md +94 -4
- package/docs/Enhanced_Installation_Flow_Design.md +498 -0
- package/docs/PRD.ko.md +110 -58
- package/docs/PRD.md +110 -58
- package/index.js +1240 -20
- package/jest.config.js +4 -0
- package/language-cli.js +279 -0
- package/language-utils.js +330 -0
- package/package.json +12 -4
- package/scripts/validate-commands.cjs +338 -0
- package/scripts/validate-commands.js +254 -0
- package/tests/basic.test.js +62 -0
- package/tests/commands.test.js +127 -0
- package/tests/installer.test.js +129 -0
- package/tests/language-utils.test.js +271 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_prime_context.md +0 -5
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime_context.md +0 -8
package/CHANGELOG.md
CHANGED
|
@@ -7,39 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
-
###
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
-
|
|
10
|
+
### New Features
|
|
11
|
+
|
|
12
|
+
- π **Multilingual Support System** - Complete English/Korean dual language support with automatic language detection
|
|
13
|
+
- π§ **Advanced Installation System** - Validation, backup, and rollback capabilities
|
|
14
|
+
- π§ͺ **Testing Infrastructure** - Jest-based automated testing framework
|
|
15
|
+
- π **Project Documentation** - Architecture, manifest, and guide documentation
|
|
16
|
+
- π― **Language Management Commands** - language_manager, language_status, switch_language
|
|
17
|
+
|
|
18
|
+
### Improvements
|
|
19
|
+
|
|
20
|
+
- π¦ **Command Standardization** - Unified terminology and quality improvements for all Korean commands
|
|
21
|
+
- π **Installation Process** - Multi-step installation with enhanced user experience
|
|
22
|
+
- π **Documentation Structure** - Language synchronization and consistency improvements
|
|
23
|
+
|
|
24
|
+
### Bug Fixes
|
|
25
|
+
|
|
26
|
+
- π§Ή **Code Cleanup** - Removed duplicate and deprecated commands
|
|
27
|
+
- β οΈ **Installation Issues** - Fixed GitHub repository path and CLI permissions
|
|
28
|
+
- π§ **Command Consistency** - Resolved synchronization issues between language versions
|
|
29
|
+
|
|
30
|
+
## [0.3.0] - 2024-12-20
|
|
31
|
+
|
|
32
|
+
### Features
|
|
33
|
+
|
|
34
|
+
- π **Multi-language Support** - Language selection during installation (English/Korean)
|
|
35
|
+
- π **Changelog Command** - Automatic generation from Git history
|
|
36
|
+
- π **Developer Hooks** - Automated testing and completion notifications
|
|
37
|
+
|
|
38
|
+
### Enhancements
|
|
39
|
+
|
|
40
|
+
- π **Documentation** - Updated README and unified guides
|
|
41
|
+
- π§ **Configuration** - Pre-commit hooks and automated workflows
|
|
42
|
+
|
|
43
|
+
### Technical Requirements
|
|
44
|
+
|
|
45
|
+
- Node.js 14.0.0+ required
|
|
46
|
+
- GitHub API integration for real-time updates
|
|
47
|
+
- Claude Code, Cursor, Windsurf IDE support
|
package/CLAUDE.md
CHANGED
|
@@ -6,215 +6,14 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
|
|
6
6
|
|
|
7
7
|
This is **aiwf** (AI Workflow Framework), an NPM package that installs the AIWF project management framework for AI-assisted development. It's an updated version of the Simone framework, specifically designed for Claude Code integration.
|
|
8
8
|
|
|
9
|
-
##
|
|
10
|
-
|
|
11
|
-
### Main Components
|
|
12
|
-
|
|
13
|
-
1. **CLI Installer (`index.js`)**: The main entry point that downloads and installs AIWF framework components from GitHub
|
|
14
|
-
2. **AIWF Framework**: A markdown-based project management system located in `claude-code/aiwf/`
|
|
15
|
-
3. **Rules System**: Development guidelines in `rules/global/` and `rules/manual/` for Cursor and Windsurf IDEs
|
|
16
|
-
|
|
17
|
-
### Key Directories
|
|
18
|
-
|
|
19
|
-
```text
|
|
20
|
-
aiwf/
|
|
21
|
-
βββ index.js # Main CLI installer with GitHub API integration
|
|
22
|
-
βββ package.json # NPM package configuration
|
|
23
|
-
βββ claude-code/aiwf/ # Complete AIWF framework
|
|
24
|
-
β βββ ko/ # Korean language version
|
|
25
|
-
β β βββ .claude/commands/ # Korean Claude Code custom commands
|
|
26
|
-
β β βββ .aiwf/ # Korean project management structure
|
|
27
|
-
β βββ en/ # English language version
|
|
28
|
-
β βββ .claude/commands/ # English Claude Code custom commands
|
|
29
|
-
β βββ .aiwf/ # English project management structure
|
|
30
|
-
βββ rules/ # IDE-specific development rules
|
|
31
|
-
βββ global/ # Always-apply rules
|
|
32
|
-
βββ manual/ # On-demand rules
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Development Commands
|
|
36
|
-
|
|
37
|
-
### Building and Testing
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
# Install dependencies
|
|
41
|
-
npm install
|
|
42
|
-
|
|
43
|
-
# Test the installer (creates .aiwf/ and .claude/ in current directory)
|
|
44
|
-
node index.js
|
|
45
|
-
|
|
46
|
-
# Test with force flag (skips prompts)
|
|
47
|
-
node index.js --force
|
|
48
|
-
|
|
49
|
-
# Publish to NPM
|
|
50
|
-
npm publish
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
### Package Usage
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
# Install AIWF in any project (interactive language selection)
|
|
57
|
-
npx aiwf
|
|
58
|
-
|
|
59
|
-
# Force installation without prompts (defaults to Korean)
|
|
60
|
-
npx aiwf --force
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Technical Implementation Details
|
|
64
|
-
|
|
65
|
-
### GitHub Integration
|
|
66
|
-
|
|
67
|
-
The installer (`index.js`) fetches content directly from the GitHub repository:
|
|
68
|
-
|
|
69
|
-
- **API URL**: `https://api.github.com/repos/aiwf/aiwf`
|
|
70
|
-
- **Raw Content**: `https://raw.githubusercontent.com/aiwf/aiwf/master`
|
|
71
|
-
- **Content Prefix**: `claude-code/aiwf`
|
|
72
|
-
- **Language Support**: Supports both Korean (`ko/`) and English (`en/`) versions
|
|
73
|
-
|
|
74
|
-
### Installation Process
|
|
75
|
-
|
|
76
|
-
1. **Language Selection**: Interactive prompt to choose between Korean and English
|
|
77
|
-
2. **Detection**: Checks for existing `.aiwf/` or `.claude/commands/aiwf/`
|
|
78
|
-
3. **Backup**: Creates timestamped backups of existing files (`.bak` format)
|
|
79
|
-
4. **Download**: Fetches framework components from GitHub based on selected language
|
|
80
|
-
5. **Setup**: Creates directory structure and copies files
|
|
81
|
-
6. **Rules Processing**: Converts rules to IDE-specific formats:
|
|
82
|
-
- Cursor: `.mdc` files with frontmatter in `.cursor/rules/`
|
|
83
|
-
- Windsurf: Plain `.md` files in `.windsurf/rules/`
|
|
84
|
-
|
|
85
|
-
### File Processing Logic
|
|
86
|
-
|
|
87
|
-
- **CLAUDE.md files**: Always updated to latest version
|
|
88
|
-
- **Commands**: Always updated from repository
|
|
89
|
-
- **Templates**: Downloaded on fresh installs only
|
|
90
|
-
- **User content**: Preserved during updates (sprints, tasks, etc.)
|
|
91
|
-
|
|
92
|
-
## AIWF Framework Integration
|
|
93
|
-
|
|
94
|
-
### Command Structure
|
|
95
|
-
|
|
96
|
-
Available via `/project:aiwf:<command>` in Claude Code:
|
|
97
|
-
|
|
98
|
-
- **Setup**: `initialize`, `prime`, `prime_context`
|
|
99
|
-
- **Planning**: `plan_milestone`, `create_sprints_from_milestone`, `create_sprint_tasks`
|
|
100
|
-
- **Development**: `do_task`, `commit`, `test`, `code_review`
|
|
101
|
-
- **Automation**: `yolo` (autonomous execution)
|
|
102
|
-
- **GitHub**: `issue_create`, `pr_create` (with `gh` CLI integration)
|
|
103
|
-
- **Analysis**: `ultrathink_*`, `mermaid`, `project_review`
|
|
104
|
-
|
|
105
|
-
### GitHub Issue Integration
|
|
106
|
-
|
|
107
|
-
The framework supports seamless GitHub integration:
|
|
108
|
-
|
|
109
|
-
- Tasks can be linked to GitHub issues via `github_issue` field
|
|
110
|
-
- Automatic status synchronization using `gh` CLI
|
|
111
|
-
- PR creation with issue linking
|
|
112
|
-
- Commit message integration (`fixes #123`, `relates to #456`)
|
|
113
|
-
|
|
114
|
-
### Project Structure Created
|
|
9
|
+
## Changelog Guidelines
|
|
115
10
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
β βββ 03_SPRINTS/ # Sprint execution
|
|
122
|
-
β βββ 04_GENERAL_TASKS/ # Standalone tasks
|
|
123
|
-
β βββ 98_PROMPTS/ # Useful prompts
|
|
124
|
-
β βββ 99_TEMPLATES/ # Document templates
|
|
125
|
-
βββ .claude/commands/aiwf/ # Claude Code commands
|
|
126
|
-
βββ .cursor/rules/ # Cursor IDE rules
|
|
127
|
-
```
|
|
11
|
+
- **Changelog Best Practices**: Always summarize changes concisely by feature or component
|
|
12
|
+
- Aim for clear, brief descriptions that highlight the key modifications in each update
|
|
13
|
+
- Group changes by type: Added, Changed, Fixed, Removed
|
|
14
|
+
- Provide context for significant changes without unnecessary details
|
|
15
|
+
- Always use English
|
|
128
16
|
|
|
129
|
-
##
|
|
130
|
-
|
|
131
|
-
### Error Handling
|
|
132
|
-
|
|
133
|
-
- Network failures during GitHub API calls are handled gracefully
|
|
134
|
-
- Backup/restore functionality for failed updates
|
|
135
|
-
- User prompts for dangerous operations
|
|
136
|
-
|
|
137
|
-
### CLI Design
|
|
138
|
-
|
|
139
|
-
Uses modern Node.js libraries:
|
|
140
|
-
|
|
141
|
-
- **commander**: CLI argument parsing
|
|
142
|
-
- **chalk**: Colored terminal output
|
|
143
|
-
- **ora**: Loading spinners
|
|
144
|
-
- **prompts**: Interactive user input
|
|
145
|
-
|
|
146
|
-
### File Management
|
|
147
|
-
|
|
148
|
-
- Recursive directory creation with `fs.mkdir({ recursive: true })`
|
|
149
|
-
- Stream-based file downloads using `pipeline()`
|
|
150
|
-
- Atomic operations with backup/restore capability
|
|
151
|
-
|
|
152
|
-
## Important Constraints
|
|
153
|
-
|
|
154
|
-
### Installation Safety
|
|
155
|
-
|
|
156
|
-
- Never overwrites user-created project content
|
|
157
|
-
- Always creates backups before updates
|
|
158
|
-
- Preserves existing work in sprints and tasks
|
|
159
|
-
|
|
160
|
-
### GitHub Dependency
|
|
161
|
-
|
|
162
|
-
- Requires internet connection for installation
|
|
163
|
-
- All content fetched from live GitHub repository
|
|
164
|
-
- Uses GitHub API rate limits (unauthenticated)
|
|
165
|
-
|
|
166
|
-
### Node.js Requirements
|
|
167
|
-
|
|
168
|
-
- Minimum Node.js 14.0.0
|
|
169
|
-
- Uses ES modules (`"type": "module"`)
|
|
170
|
-
- Requires `https` and `fs/promises` support
|
|
171
|
-
|
|
172
|
-
## Working with This Codebase
|
|
173
|
-
|
|
174
|
-
### Making Changes to Framework
|
|
175
|
-
|
|
176
|
-
1. Modify files in `claude-code/aiwf/`
|
|
177
|
-
2. Test locally with `node index.js`
|
|
178
|
-
3. Commit and push to GitHub
|
|
179
|
-
4. Framework updates are automatically available via `npx aiwf`
|
|
180
|
-
|
|
181
|
-
### Adding New Commands
|
|
182
|
-
|
|
183
|
-
1. Create command files in both language directories:
|
|
184
|
-
- Korean: `claude-code/aiwf/ko/.claude/commands/aiwf/`
|
|
185
|
-
- English: `claude-code/aiwf/en/.claude/commands/aiwf/`
|
|
186
|
-
2. Follow naming conventions:
|
|
187
|
-
- Korean versions can use `_kr` suffix for clarity
|
|
188
|
-
- English versions use standard naming
|
|
189
|
-
3. Update documentation in `docs/COMMANDS_GUIDE.md`
|
|
190
|
-
|
|
191
|
-
### Modifying Installation Logic
|
|
192
|
-
|
|
193
|
-
- Main installer logic is in `index.js`
|
|
194
|
-
- Language selection and message handling in `messages` object
|
|
195
|
-
- GitHub API integration in `fetchGitHubContent()` and `downloadFile()`
|
|
196
|
-
- Directory processing in `downloadDirectory()`
|
|
197
|
-
- Backup logic in `backupCommandsAndDocs()`
|
|
198
|
-
- Language-specific path resolution using `GITHUB_CONTENT_LANGUAGE_PREFIX`
|
|
199
|
-
|
|
200
|
-
## Multilingual Support
|
|
201
|
-
|
|
202
|
-
### Language Structure
|
|
203
|
-
|
|
204
|
-
The framework supports both Korean and English through:
|
|
205
|
-
|
|
206
|
-
- **Separate directory structure**: `ko/` and `en/` folders contain language-specific content
|
|
207
|
-
- **Interactive language selection**: Users choose their preferred language during installation
|
|
208
|
-
- **Localized messages**: All installation messages are available in both languages
|
|
209
|
-
- **Command localization**: Commands are available in both languages with appropriate naming
|
|
210
|
-
|
|
211
|
-
### Adding New Languages
|
|
212
|
-
|
|
213
|
-
To add support for additional languages:
|
|
214
|
-
|
|
215
|
-
1. Create new language directory: `claude-code/aiwf/{lang_code}/`
|
|
216
|
-
2. Copy and translate content from existing language directory
|
|
217
|
-
3. Add language option to `messages` object in `index.js`
|
|
218
|
-
4. Update language selection prompt in `installAIWF()` function
|
|
17
|
+
## Core Architecture
|
|
219
18
|
|
|
220
|
-
|
|
19
|
+
[... rest of the existing content remains unchanged ...]
|
package/README.md
CHANGED
|
@@ -22,10 +22,11 @@ npx aiwf
|
|
|
22
22
|
|
|
23
23
|
The installer will:
|
|
24
24
|
|
|
25
|
-
1. **Language
|
|
26
|
-
2. **
|
|
27
|
-
3. **
|
|
28
|
-
4. **
|
|
25
|
+
1. **Intelligent Language Detection**: Automatically detect your system language or let you choose
|
|
26
|
+
2. **Language Preference Storage**: Save your language preference for future installations
|
|
27
|
+
3. **Directory Setup**: Create the `.aiwf/` directory structure for project management
|
|
28
|
+
4. **Commands**: Set up `.claude/commands/aiwf/` with localized Claude commands
|
|
29
|
+
5. **Content**: Download the latest templates and documentation in your selected language
|
|
29
30
|
|
|
30
31
|
## π Usage
|
|
31
32
|
|
|
@@ -43,9 +44,28 @@ If AIWF is already installed, the installer will automatically detect it and off
|
|
|
43
44
|
- Skip installation
|
|
44
45
|
- Cancel
|
|
45
46
|
|
|
47
|
+
### Language Management
|
|
48
|
+
|
|
49
|
+
AIWF includes a sophisticated language management system:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# Check current language settings
|
|
53
|
+
aiwf-lang status
|
|
54
|
+
|
|
55
|
+
# Change language interactively
|
|
56
|
+
aiwf-lang set
|
|
57
|
+
|
|
58
|
+
# Set specific language
|
|
59
|
+
aiwf-lang set ko # Korean
|
|
60
|
+
aiwf-lang set en # English
|
|
61
|
+
|
|
62
|
+
# Reset to auto-detection
|
|
63
|
+
aiwf-lang reset
|
|
64
|
+
```
|
|
65
|
+
|
|
46
66
|
### Force Installation
|
|
47
67
|
|
|
48
|
-
Skip all prompts and force installation (
|
|
68
|
+
Skip all prompts and force installation (uses auto-detected language):
|
|
49
69
|
|
|
50
70
|
```bash
|
|
51
71
|
npx aiwf --force
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# Update Documentation
|
|
2
|
+
|
|
3
|
+
Analyze current project documentation and update it to reflect implementation progress and recent changes.
|
|
4
|
+
|
|
5
|
+
## Create a TODO with EXACTLY these 10 Items
|
|
6
|
+
|
|
7
|
+
1. Analyze documentation update scope
|
|
8
|
+
2. Review project manifest and milestones
|
|
9
|
+
3. Assess sprint documentation status
|
|
10
|
+
4. Update ARCHITECTURE.md if needed
|
|
11
|
+
5. Update milestone requirements documentation
|
|
12
|
+
6. Update sprint documentation
|
|
13
|
+
7. Review and update PROJECT_MANIFEST.md
|
|
14
|
+
8. Update README.md and project documentation
|
|
15
|
+
9. Update additional documentation folders
|
|
16
|
+
10. Generate documentation update summary
|
|
17
|
+
|
|
18
|
+
Follow step by step and adhere closely to the following instructions for each step.
|
|
19
|
+
|
|
20
|
+
## DETAILS on every TODO item
|
|
21
|
+
|
|
22
|
+
### 1. Analyze documentation update scope
|
|
23
|
+
|
|
24
|
+
Check: <$ARGUMENTS>
|
|
25
|
+
|
|
26
|
+
If empty, perform full documentation review. Otherwise interpret <$ARGUMENTS> to identify specific focus areas (milestone, sprint, architecture component, etc.).
|
|
27
|
+
|
|
28
|
+
**CRITICAL:** Read `.aiwf/00_PROJECT_MANIFEST.md` FIRST to understand:
|
|
29
|
+
- Current milestone and sprint status
|
|
30
|
+
- What work is complete vs in-progress vs planned
|
|
31
|
+
- Recent changes that need documentation
|
|
32
|
+
|
|
33
|
+
### 2. Review project manifest and milestones
|
|
34
|
+
|
|
35
|
+
**USE PARALLEL AGENTS** to:
|
|
36
|
+
- READ `.aiwf/00_PROJECT_MANIFEST.md` for current status
|
|
37
|
+
- READ all milestone requirements in `.aiwf/02_REQUIREMENTS/`
|
|
38
|
+
- IDENTIFY what has changed since last documentation update
|
|
39
|
+
- CHECK for any milestones marked as completed that need status updates
|
|
40
|
+
|
|
41
|
+
### 3. Assess sprint documentation status
|
|
42
|
+
|
|
43
|
+
**USE PARALLEL AGENTS** to:
|
|
44
|
+
- NAVIGATE to `.aiwf/03_SPRINTS/` to find current and completed sprints
|
|
45
|
+
- READ sprint meta files to understand deliverables
|
|
46
|
+
- CHECK task completion status within each sprint
|
|
47
|
+
- IDENTIFY sprints that need status updates or completion markers
|
|
48
|
+
|
|
49
|
+
### 4. Update ARCHITECTURE.md if needed
|
|
50
|
+
|
|
51
|
+
- READ `.aiwf/01_PROJECT_DOCS/ARCHITECTURE.md`
|
|
52
|
+
- REVIEW implementation to see if architecture has evolved
|
|
53
|
+
- UPDATE diagrams if structure has changed
|
|
54
|
+
- ADD new components or modules discovered during implementation
|
|
55
|
+
- DOCUMENT any architectural decisions made during recent sprints
|
|
56
|
+
|
|
57
|
+
**IMPORTANT:** Only update if architecture has actually changed. Don't modify for minor details.
|
|
58
|
+
|
|
59
|
+
### 5. Update milestone requirements documentation
|
|
60
|
+
|
|
61
|
+
For each active or recently completed milestone:
|
|
62
|
+
- NAVIGATE to `.aiwf/02_REQUIREMENTS/M{N}_*/`
|
|
63
|
+
- UPDATE `requirements.md` with:
|
|
64
|
+
- β
Completed requirements
|
|
65
|
+
- π§ In-progress items with % complete
|
|
66
|
+
- π Planned items not yet started
|
|
67
|
+
- β Deferred or removed requirements with justification
|
|
68
|
+
- ADD implementation notes for complex features
|
|
69
|
+
- DOCUMENT any requirement changes or clarifications
|
|
70
|
+
|
|
71
|
+
### 6. Update sprint documentation
|
|
72
|
+
|
|
73
|
+
For current and recently completed sprints:
|
|
74
|
+
- NAVIGATE to `.aiwf/03_SPRINTS/S{N}_*/`
|
|
75
|
+
- UPDATE sprint meta file with:
|
|
76
|
+
- Current status (PLANNED/IN_PROGRESS/COMPLETED)
|
|
77
|
+
- Completion percentage
|
|
78
|
+
- Actual vs planned deliverables
|
|
79
|
+
- UPDATE individual task files:
|
|
80
|
+
- Mark completed tasks with β
|
|
81
|
+
- Add implementation notes
|
|
82
|
+
- Document any blockers or challenges
|
|
83
|
+
- Link to relevant code files
|
|
84
|
+
|
|
85
|
+
### 7. Review and update PROJECT_MANIFEST.md
|
|
86
|
+
|
|
87
|
+
Update the manifest with:
|
|
88
|
+
- **Current Status**: Update milestone and sprint progress
|
|
89
|
+
- **Sprint Tracking**: Mark completed sprints, update current sprint
|
|
90
|
+
- **Deliverables**: Update completion status for each deliverable
|
|
91
|
+
- **Recent Achievements**: Add notable completions
|
|
92
|
+
- **Known Issues**: Document any blockers or technical debt
|
|
93
|
+
- **Next Steps**: Update based on completed work
|
|
94
|
+
|
|
95
|
+
**Format Example:**
|
|
96
|
+
```markdown
|
|
97
|
+
## Current Status
|
|
98
|
+
- **Active Milestone**: M01 - [Name] (75% complete)
|
|
99
|
+
- **Current Sprint**: S03 - [Focus] (IN PROGRESS - 40% complete)
|
|
100
|
+
- **Last Updated**: YYYY-MM-DD HH:MM
|
|
101
|
+
|
|
102
|
+
## Sprint Progress
|
|
103
|
+
|
|
104
|
+
### Current Sprint (S03)
|
|
105
|
+
**Status**: IN PROGRESS (40% complete)
|
|
106
|
+
**Deliverables**:
|
|
107
|
+
- β
[Completed feature] - Done
|
|
108
|
+
- π§ [In-progress feature] - 60% complete
|
|
109
|
+
- π [Planned feature] - Not started
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 8. Update README.md and project documentation
|
|
113
|
+
|
|
114
|
+
**Review and update the project's main README.md:**
|
|
115
|
+
- CHECK if README.md exists in project root
|
|
116
|
+
- UPDATE project description if scope has evolved
|
|
117
|
+
- REFRESH installation/setup instructions based on recent changes
|
|
118
|
+
- UPDATE usage examples with new features
|
|
119
|
+
- ADD/UPDATE badges (build status, test coverage, version)
|
|
120
|
+
- DOCUMENT new dependencies or requirements
|
|
121
|
+
- UPDATE contributing guidelines if process changed
|
|
122
|
+
- REFRESH API documentation if endpoints changed
|
|
123
|
+
|
|
124
|
+
**Key sections to review:**
|
|
125
|
+
- Project overview and purpose
|
|
126
|
+
- Features list (mark completed/in-progress/planned)
|
|
127
|
+
- Installation and setup instructions
|
|
128
|
+
- Usage examples and code snippets
|
|
129
|
+
- Configuration options
|
|
130
|
+
- API reference (if applicable)
|
|
131
|
+
- Contributing guidelines
|
|
132
|
+
- License information
|
|
133
|
+
|
|
134
|
+
### 9. Update additional documentation folders
|
|
135
|
+
|
|
136
|
+
**Search and update all documentation across the project:**
|
|
137
|
+
|
|
138
|
+
**Common documentation locations to check:**
|
|
139
|
+
- `docs/` - Main documentation folder
|
|
140
|
+
- `documentation/` - Alternative documentation folder
|
|
141
|
+
- `doc/` - Short form documentation folder
|
|
142
|
+
- `api-docs/` - API-specific documentation
|
|
143
|
+
- `*.md` files in project root (CONTRIBUTING.md, CHANGELOG.md, etc.)
|
|
144
|
+
|
|
145
|
+
**For each documentation folder found:**
|
|
146
|
+
- REVIEW all markdown files for outdated information
|
|
147
|
+
- UPDATE technical specifications with implementation details
|
|
148
|
+
- REFRESH user guides with new features
|
|
149
|
+
- UPDATE API documentation with new endpoints/changes
|
|
150
|
+
- ADD migration guides if breaking changes introduced
|
|
151
|
+
- UPDATE troubleshooting sections with known issues/solutions
|
|
152
|
+
|
|
153
|
+
**Specific files to check:**
|
|
154
|
+
- `CHANGELOG.md` - Add recent changes and version updates
|
|
155
|
+
- `CONTRIBUTING.md` - Update development workflow if changed
|
|
156
|
+
- `docs/setup.md` - Refresh installation/configuration steps
|
|
157
|
+
- `docs/api.md` - Update API endpoints and examples
|
|
158
|
+
- `docs/deployment.md` - Update deployment procedures
|
|
159
|
+
- `docs/testing.md` - Document new test procedures
|
|
160
|
+
|
|
161
|
+
**Documentation consistency checks:**
|
|
162
|
+
- Ensure version numbers are consistent across all docs
|
|
163
|
+
- Verify code examples still work with current implementation
|
|
164
|
+
- Update screenshots/diagrams if UI/architecture changed
|
|
165
|
+
- Check that all links (internal and external) are valid
|
|
166
|
+
- Ensure terminology is consistent throughout
|
|
167
|
+
|
|
168
|
+
### 10. Generate documentation update summary
|
|
169
|
+
|
|
170
|
+
Create a summary report of all documentation updates:
|
|
171
|
+
|
|
172
|
+
```markdown
|
|
173
|
+
# Documentation Update Summary - [YYYY-MM-DD]
|
|
174
|
+
|
|
175
|
+
## Files Updated
|
|
176
|
+
|
|
177
|
+
### AIWF Documentation
|
|
178
|
+
- `.aiwf/00_PROJECT_MANIFEST.md` - [brief description of changes]
|
|
179
|
+
- `.aiwf/01_PROJECT_DOCS/ARCHITECTURE.md` - [if updated]
|
|
180
|
+
- `.aiwf/02_REQUIREMENTS/M01_*/requirements.md` - [status updates]
|
|
181
|
+
- `.aiwf/03_SPRINTS/S0N_*/meta.md` - [sprint status changes]
|
|
182
|
+
|
|
183
|
+
### Project Documentation
|
|
184
|
+
- `README.md` - [main project documentation updates]
|
|
185
|
+
- `CHANGELOG.md` - [version and change history updates]
|
|
186
|
+
- `CONTRIBUTING.md` - [contribution guideline updates]
|
|
187
|
+
- `docs/*.md` - [specific documentation file updates]
|
|
188
|
+
- Other documentation folders - [list any additional updates]
|
|
189
|
+
|
|
190
|
+
## Key Changes
|
|
191
|
+
1. [Major documentation change or update]
|
|
192
|
+
2. [New sections added]
|
|
193
|
+
3. [Status updates applied]
|
|
194
|
+
|
|
195
|
+
## Project Status After Update
|
|
196
|
+
- **Milestone Progress**: M01 at X% (was Y%)
|
|
197
|
+
- **Sprint Progress**: S0N at X% (was Y%)
|
|
198
|
+
- **Documentation Coverage**: [assessment of documentation completeness]
|
|
199
|
+
|
|
200
|
+
## Recommendations
|
|
201
|
+
- [Any documentation gaps identified]
|
|
202
|
+
- [Suggested documentation improvements]
|
|
203
|
+
- [Areas needing clarification]
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
## Guidelines
|
|
207
|
+
|
|
208
|
+
- PRESERVE original requirements and plans (use strikethrough or status markers)
|
|
209
|
+
- MAINTAIN consistent status indicators (β
, π§, π, β)
|
|
210
|
+
- UPDATE percentages based on actual implementation
|
|
211
|
+
- DOCUMENT deviations from original plan with justification
|
|
212
|
+
- KEEP documentation concise but comprehensive
|
|
213
|
+
- ENSURE all dates and timestamps are current
|
|
214
|
+
- CROSS-REFERENCE related documentation sections
|
|
215
|
+
- SEARCH for all .md files across the project, not just in expected locations
|
|
216
|
+
- CHECK root directory for standalone documentation files
|
|
217
|
+
- VERIFY all code examples in documentation still work
|
|
218
|
+
- ENSURE documentation is accessible to new team members
|
|
219
|
+
|
|
220
|
+
**IMPORTANT:** Documentation should reflect reality. Update based on actual implementation status, not aspirational goals.
|
|
221
|
+
|
|
222
|
+
**CRITICAL:** Don't assume documentation locations. Always search the entire project for:
|
|
223
|
+
- `*.md` files in any directory
|
|
224
|
+
- Common names: README, CHANGELOG, CONTRIBUTING, LICENSE, INSTALL, USAGE
|
|
225
|
+
- Documentation in unexpected places (e.g., inside src/, lib/, or other code directories)
|