From e7d6b398639fb2e25ee9152743c81240faba0aea Mon Sep 17 00:00:00 2001 From: snowprint Date: Sat, 4 Oct 2025 18:12:45 +0800 Subject: [PATCH] docs(workflow): add detailed step-by-step development process - Define 5 phases: Setup, Implementation, QA, Testing, Deployment - Break down each phase into specific steps with owners - Mark Phase 1 (Project Setup) as complete - Set current phase to Phase 2 (Design & Implementation) - Add progress tracking section - Specify next immediate action: Design ASCII Art Logo - Include workflow rules and sequential completion requirements Provides clear roadmap for project completion. --- CLAUDE.md | 198 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 177 insertions(+), 21 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 41972cb..f777261 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -185,33 +185,187 @@ See `.claude/time-recording-policy.md` for complete guidelines. ## Development Workflow -### Standard Development Process +### Step-by-Step Process for This Project -1. **Implementation** (Primary Agent) - - Write code based on requirements - - Follow design guidelines - - Commit changes with proper messages +#### Phase 1: Project Setup ✅ COMPLETE -2. **Review** (code-reviewer agent - if needed) - - Invoke after completing logical work units - - Review for quality, security, performance +**Step 1.1: Initialize Documentation** +- ✅ Create CLAUDE.md with project requirements +- ✅ Create README.md with project overview +- ✅ Create project-spec.md with detailed specifications +- ✅ Create CONTRIBUTING.md with Git workflow +- ✅ Create CHANGELOG.md for version tracking +- **Owner**: Primary Agent +- **Completed**: 2025-10-04 08:50:35 UTC / 16:50:35 GMT+8 -3. **Testing** (test-engineer agent - if requested) - - Create test cases when user asks - - Validate functionality +**Step 1.2: Setup Version Control** +- ✅ Initialize Git repository +- ✅ Configure remote repository +- ✅ Create .gitignore file +- ✅ Initial commit and push +- **Owner**: Primary Agent +- **Completed**: 2025-10-04 08:50:35 UTC / 16:50:35 GMT+8 -4. **Deployment** (devops-engineer agent - if needed) - - Setup deployment pipeline - - Configure hosting +**Step 1.3: Establish Policies** +- ✅ Create agent constitution +- ✅ Define time recording policy +- ✅ Document Git workflow for agents +- **Owner**: Primary Agent +- **Completed**: 2025-10-04 08:50:35 UTC / 16:50:35 GMT+8 -### Current Project Status +--- -1. ✅ Create project README with setup instructions -2. ✅ Set up Git repository and workflow documentation -3. ⏳ Implement main Halloween event page (index.html) -4. ⏳ Test responsive behavior on various devices -5. ⏳ Validate HTML5 compliance -6. ⏳ Deploy to hosting platform +#### Phase 2: Design & Implementation ⏳ IN PROGRESS + +**Step 2.1: Design ASCII Art Logo** +- ⏳ Create McDonald's ASCII art (desktop version) +- ⏳ Create McDonald's ASCII art (mobile version) +- ⏳ Test legibility on different screen sizes +- **Owner**: Primary Agent +- **Consultant**: minimalist-geek-webpage-builder (if needed) +- **Status**: Not started + +**Step 2.2: Implement HTML Structure** +- ⏳ Create index.html with semantic HTML5 +- ⏳ Add meta tags for responsive design +- ⏳ Structure content sections (logo, event info, activities) +- ⏳ Add accessibility attributes (ARIA labels, alt text) +- **Owner**: Primary Agent +- **Status**: Not started + +**Step 2.3: Implement CSS Styling** +- ⏳ Add inline CSS for terminal aesthetic +- ⏳ Implement black background with high-contrast text +- ⏳ Style with monospace fonts +- ⏳ Create responsive breakpoints (mobile/tablet/desktop) +- ⏳ Ensure no shadows, gradients, or decorative effects +- **Owner**: Primary Agent +- **Status**: Not started + +**Step 2.4: Add Event Content** +- ⏳ Insert Halloween event details (date TBD, time TBD, location) +- ⏳ List activities and schedule +- ⏳ Add RSVP or contact information +- **Owner**: Primary Agent +- **Consultant**: product-manager (for content prioritization if needed) +- **Status**: Not started + +**Step 2.5: Commit Implementation** +- ⏳ Review changes locally +- ⏳ Commit with message: `feat(page): implement Halloween event page` +- ⏳ Push to remote repository +- **Owner**: Primary Agent +- **Status**: Not started + +--- + +#### Phase 3: Quality Assurance ⏳ PENDING + +**Step 3.1: Code Review** +- ⏳ Invoke code-reviewer agent +- ⏳ Review for code quality, security, performance +- ⏳ Address any findings +- ⏳ Commit fixes if needed +- **Owner**: code-reviewer agent (consultant) +- **Status**: Pending Phase 2 completion + +**Step 3.2: UX Evaluation** +- ⏳ Invoke ux-expert agent (optional) +- ⏳ Evaluate usability and accessibility +- ⏳ Check WCAG 2.1 AA compliance +- ⏳ Implement UX improvements if needed +- **Owner**: ux-expert agent (consultant) +- **Status**: Pending Phase 2 completion + +**Step 3.3: Responsive Testing** +- ⏳ Test on desktop (1024px+) +- ⏳ Test on tablet (768-1023px) +- ⏳ Test on mobile (320-767px) +- ⏳ Verify ASCII art legibility on all sizes +- ⏳ Test on multiple browsers (Chrome, Firefox, Safari, Edge) +- **Owner**: Primary Agent +- **Status**: Pending Phase 2 completion + +**Step 3.4: HTML5 Validation** +- ⏳ Validate HTML5 compliance +- ⏳ Fix any validation errors +- ⏳ Verify semantic markup +- **Owner**: Primary Agent +- **Status**: Pending Phase 2 completion + +**Step 3.5: Performance Check** +- ⏳ Verify page load time < 1 second +- ⏳ Check file size < 50KB +- ⏳ Ensure no external dependencies +- **Owner**: Primary Agent +- **Status**: Pending Phase 2 completion + +--- + +#### Phase 4: Testing (Optional) ⏳ PENDING + +**Step 4.1: Create Test Cases** +- ⏳ Invoke test-engineer agent (if user requests) +- ⏳ Design test cases for functionality +- ⏳ Create accessibility tests +- ⏳ Document test results +- **Owner**: test-engineer agent (consultant) +- **Status**: Optional - only if requested + +--- + +#### Phase 5: Deployment ⏳ PENDING + +**Step 5.1: Prepare for Deployment** +- ⏳ Final review of index.html +- ⏳ Update CHANGELOG.md with release notes +- ⏳ Create Git tag for v1.0.0 +- **Owner**: Primary Agent +- **Status**: Pending Phase 3 completion + +**Step 5.2: Deploy to Hosting** +- ⏳ Choose hosting platform (GitHub Pages, Netlify, etc.) +- ⏳ Upload index.html +- ⏳ Verify live site functionality +- ⏳ Test on production environment +- **Owner**: Primary Agent +- **Consultant**: devops-engineer (for complex deployment) +- **Status**: Pending Phase 5.1 completion + +**Step 5.3: Documentation Update** +- ⏳ Update README.md with deployment URL +- ⏳ Document deployment process +- ⏳ Mark project as complete in CLAUDE.md +- **Owner**: Primary Agent +- **Status**: Pending Phase 5.2 completion + +--- + +### Current Phase: Phase 2 - Design & Implementation + +**Next Immediate Step**: Step 2.1 - Design ASCII Art Logo + +**Action Required**: Create McDonald's ASCII art for the webpage + +### Workflow Rules + +1. **Complete steps sequentially** - Don't skip ahead +2. **Primary agent does the work** - Specialists consult only when specified +3. **Commit after each major step** - Maintain clean Git history +4. **Update this document** - Mark steps complete with timestamps +5. **Ask user for confirmation** - Before moving to next phase + +## Progress Tracking + +**Overall Progress**: 25% (Phase 1 complete, Phase 2-5 pending) + +**Current Phase**: Phase 2 - Design & Implementation +**Current Step**: Step 2.1 - Design ASCII Art Logo +**Next Action**: Create McDonald's ASCII art + +**Last Updated**: 2025-10-04 08:50:35 UTC / 2025-10-04 16:50:35 GMT+8 + +--- ## Quick Reference @@ -219,3 +373,5 @@ See `.claude/time-recording-policy.md` for complete guidelines. **Specialist Agents**: Provide expert consultation only when specifically needed **Remember**: You are capable and should handle most tasks directly. Don't over-delegate. + +**Workflow**: Follow the step-by-step process above. Complete each step before moving to the next.