AndersPier/neural-nexus-claude-project
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Complete README update with comprehensive file structure and detailed descriptions

Browse Source
This commit is contained in:
Anders Lehmann Pier
2025-06-13 10:32:51 +02:00
parent bed5138471
commit c50c9fc496
1 changed files with 152 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

196
README.md
View File

@@ -4,39 +4,40 @@
``` ```
neural-nexus-claude-project/ neural-nexus-claude-project/
├── README.md # This file - project maintenance guide ├── README.md # This file - comprehensive project maintenance guide
├── .gitignore # Git ignore patterns ├── .gitignore # Git ignore patterns for documentation workflow
├── LICENSE # MIT License for project methodology
├── project-config/ ├── project-config/
│ ├── project-description.md # Current project description template │ ├── project-description.md # Ready-to-use Claude Project description template
│ ├── project-instructions.md # Custom instructions for Claude │ ├── project-instructions.md # Complete behavior instructions for Claude
│ └── stage-transition-templates.md # Templates for moving between stages │ └── stage-transition-templates.md # Templates for moving between development stages
├── documentation/ ├── documentation/
│ ├── development-guide.md # Technical development documentation │ ├── development-guide.md # Technical development reference and architecture
│ ├── user-guide.md # Player-focused game guide │ ├── user-guide.md # Player-focused game guide and troubleshooting
│ └── game-design-decisions.md # Record of design choices and rationale │ └── game-design-decisions.md # Complete record of design choices and rationale
├── knowledge-base/ ├── knowledge-base/
│ ├── game-design/ │ ├── game-design/
│ │ ├── core-mechanics.md │ │ ├── core-mechanics.md # Game mechanics and connection system documentation
│ │ ├── level-progression.md │ │ ├── scoring-system.md # Points calculation and player reward systems
│ │ ├── scoring-system.md │ │ └── visual-design-guide.md # Complete visual design system and styling guide
│ │ └── visual-design-guide.md
│ ├── technical/ │ ├── technical/
│ │ ├── performance-optimization.md │ │ ├── performance-optimization.md # Canvas optimization and memory management
│ │ ├── cross-platform-notes.md │ │ ├── cross-platform-notes.md # Device compatibility and responsive design
│ │ └── testing-protocols.md │ │ └── testing-protocols.md # Manual testing procedures and checklists
│ └── development/ │ └── development/
│ ├── feature-roadmap.md │ ├── feature-roadmap.md # Development planning and feature prioritization
│ ├── session-logs/ │ ├── decision-history.md # Chronological record of all major decisions
│ └── decision-history.md │ └── session-logs/ # Directory for individual development session logs
│ └── README.md # Guide for session log format and maintenance
├── templates/ ├── templates/
│ ├── session-start-prompt.md │ ├── session-start-prompt.md # Daily session startup template
│ ├── session-end-prompt.md │ ├── session-end-prompt.md # Critical session consolidation template
│ ├── weekly-review-prompt.md │ ├── weekly-review-prompt.md # Weekly project health assessment
│ └── stage-transition-prompt.md │ └── stage-transition-prompt.md # Comprehensive stage transition analysis
└── workflow/ └── workflow/
├── daily-routine.md ├── daily-routine.md # Daily development habits and best practices
├── emergency-recovery.md ├── emergency-recovery.md # Comprehensive recovery procedures for all issues
└── best-practices.md └── best-practices.md # Development workflow optimization guidelines
``` ```
## Getting Started with This Claude Project ## Getting Started with This Claude Project
@@ -62,7 +63,7 @@ Neural Nexus development check-in:
- Priority focus: gameplay mechanics, visual polish, or technical optimization? - Priority focus: gameplay mechanics, visual polish, or technical optimization?
``` ```
**End Each Session:** **End Each Session (CRITICAL):**
```bash ```bash
# Always use this prompt (from templates/session-end-prompt.md): # Always use this prompt (from templates/session-end-prompt.md):
# [See full template in templates/ directory] # [See full template in templates/ directory]
@@ -80,6 +81,47 @@ Neural Nexus development check-in:
- Archive outdated documentation - Archive outdated documentation
- Update project description if stage has changed - Update project description if stage has changed
## File Descriptions
### Core Configuration
- **project-description.md**: Current stage description for Claude Project setup
- **project-instructions.md**: Custom instructions that define Claude's behavior throughout development
- **stage-transition-templates.md**: Comprehensive templates for moving between Exploration, Prototype, Development, and Production stages
### Documentation
- **development-guide.md**: Technical reference covering architecture, performance optimization, and troubleshooting
- **user-guide.md**: Player-focused documentation with gameplay instructions and troubleshooting
- **game-design-decisions.md**: Complete record of all design choices with rationale, alternatives considered, and impact analysis
### Knowledge Base
#### Game Design
- **core-mechanics.md**: Connection system, node types, level generation, and difficulty progression documentation
- **scoring-system.md**: Points calculation, time bonuses, accuracy multipliers, and player reward psychology
- **visual-design-guide.md**: Complete visual design system including color palette, typography, layout, animations, and responsive design
#### Technical
- **performance-optimization.md**: Canvas rendering optimization, memory management, and cross-platform performance guidelines
- **cross-platform-notes.md**: Device compatibility, responsive design implementation, and touch optimization
- **testing-protocols.md**: Manual testing procedures, device compatibility checklists, and quality assurance processes
#### Development
- **feature-roadmap.md**: Development planning, feature prioritization, timeline estimates, and success criteria
- **decision-history.md**: Chronological record of all major development decisions with context, rationale, and alternatives
- **session-logs/**: Directory containing individual development session logs with standardized format and maintenance guidelines
### Templates
Ready-to-use prompts for consistent Claude Project workflow:
- **session-start-prompt.md**: Daily development session initialization with context setting and priority identification
- **session-end-prompt.md**: Critical session consolidation template for knowledge capture and progress tracking
- **weekly-review-prompt.md**: Comprehensive weekly project health assessment and planning
- **stage-transition-prompt.md**: Detailed analysis template for transitioning between development stages
### Workflow
- **daily-routine.md**: Complete daily development workflow including session management, testing procedures, and quality control
- **emergency-recovery.md**: Comprehensive recovery procedures for context loss, technical issues, architecture drift, and performance problems
- **best-practices.md**: Development workflow optimization guidelines and lessons learned
## Repository Maintenance ## Repository Maintenance
### Keeping Documentation Current ### Keeping Documentation Current
@@ -88,16 +130,19 @@ Neural Nexus development check-in:
- Add key decisions to `knowledge-base/development/decision-history.md` - Add key decisions to `knowledge-base/development/decision-history.md`
- Update feature status in `knowledge-base/development/feature-roadmap.md` - Update feature status in `knowledge-base/development/feature-roadmap.md`
- Log any performance findings in `knowledge-base/technical/` - Log any performance findings in `knowledge-base/technical/`
- Create session log in `knowledge-base/development/session-logs/`
2. **Weekly Updates:** 2. **Weekly Updates:**
- Review and update project description if needed - Review and update project description if needed
- Add new patterns to technical documentation - Add new patterns to technical documentation
- Update game design documentation with balance changes - Update game design documentation with balance changes
- Run weekly review prompt and archive results
3. **Stage Transitions:** 3. **Stage Transitions:**
- Use templates in `project-config/stage-transition-templates.md` - Use templates in `project-config/stage-transition-templates.md`
- Archive current stage documentation - Archive current stage documentation
- Update project name and instructions for new stage - Update project name and instructions for new stage
- Consolidate knowledge base for new stage focus
### Git Workflow ### Git Workflow
@@ -116,35 +161,93 @@ git commit -m "project: transition to [new-stage] stage"
git tag -a v1.0-prototype -m "Prototype stage completion" git tag -a v1.0-prototype -m "Prototype stage completion"
``` ```
## File Descriptions ## Emergency Procedures
### Core Configuration ### Context Loss Recovery
- **project-description.md**: Current stage description for Claude Project If Claude loses project context:
- **project-instructions.md**: Custom instructions that define Claude's behavior 1. Use `workflow/emergency-recovery.md` procedures
- **stage-transition-templates.md**: Templates for moving between development stages 2. Re-upload key documentation from `knowledge-base/`
3. Run context reconstruction prompt from templates
### Documentation ### Project Corruption
- **development-guide.md**: Technical reference for building the game If Claude Project becomes unusable:
- **user-guide.md**: Player-focused documentation and troubleshooting 1. Create new project with current stage name
- **game-design-decisions.md**: Record of design choices and their rationale 2. Upload all current documentation from this repository
3. Use `project-config/` files to recreate project settings
### Knowledge Base ## Best Practices
Organized documentation that gets uploaded to Claude Projects:
- **game-design/**: Mechanics, progression, scoring, visual design
- **technical/**: Performance, cross-platform compatibility, testing
- **development/**: Feature roadmap, session logs, decision history
### Templates ### Documentation Hygiene
Ready-to-use prompts for consistent Claude Project workflow: - Keep knowledge base under 10MB total
- **session-start-prompt.md**: Beginning of each development session - Archive outdated decisions and old session logs
- **session-end-prompt.md**: End of session consolidation (CRITICAL) - Maintain clear file naming conventions
- **weekly-review-prompt.md**: Friday progress review - Update templates based on what works in practice
- **stage-transition-prompt.md**: Moving between development stages
### Workflow Discipline
- **Never skip session end consolidation** - 5 minutes saves hours later
- **Update documentation immediately** - Fresh memory = better docs
- **Use stage transitions properly** - Don't rush between stages
- **Trust the system** - Consistency compounds over time
### Quality Control
- Review documentation monthly for outdated information
- Ensure project instructions reflect current development approach
- Keep templates updated based on actual usage patterns
- Maintain clear decision history for future reference
## Success Metrics
### Project Health Indicators
- ✅ Clear next steps every session
- ✅ Consistent architectural decisions
- ✅ Growing knowledge base with relevant patterns
- ✅ Smooth stage transitions when appropriate
- ✅ Minimal context repetition needed
### Warning Signs
- 🚨 Repeating context to Claude → Emergency consolidation needed
- 🚨 Contradicting earlier decisions → Review decision history
- 🚨 Unclear next steps → Run project status reconstruction
- 🚨 Large knowledge base files → Archive and reorganize
## Contributing to This System
This repository represents a living system for maintaining Claude Projects effectively. Improvements welcome:
1. **Template Refinements**: Better prompts based on actual usage
2. **Workflow Optimizations**: More efficient daily/weekly routines
3. **Documentation Patterns**: Better organization schemes
4. **Emergency Procedures**: Additional recovery strategies
## Links and Resources ## Links and Resources
- **Game Repository**: [https://github.com/AndersPier/neural-nexus-game](https://github.com/AndersPier/neural-nexus-game) - **Game Repository**: [https://github.com/AndersPier/neural-nexus-game](https://github.com/AndersPier/neural-nexus-game)
- **Live Game**: [https://andersPier.github.io/neural-nexus-game/](https://andersPier.github.io/neural-nexus-game/)
- **Claude Projects**: [Link to your Claude Project] - **Claude Projects**: [Link to your Claude Project]
- **Documentation Standards**: See `workflow/best-practices.md`
## Usage Examples
### Setting Up a New Feature
1. Review `knowledge-base/development/feature-roadmap.md` for current priorities
2. Use `templates/session-start-prompt.md` to begin development session
3. Document decisions in `knowledge-base/development/decision-history.md`
4. Update progress in feature roadmap
5. Use `templates/session-end-prompt.md` to consolidate session
### Stage Transition Process
1. Assess readiness using `project-config/stage-transition-templates.md`
2. Run comprehensive knowledge consolidation
3. Update project configuration for new stage
4. Archive previous stage documentation
5. Upload refined documentation to Claude Project
### Emergency Recovery
1. Identify issue type (context loss, technical problem, architecture drift)
2. Follow specific procedure in `workflow/emergency-recovery.md`
3. Use appropriate recovery templates
4. Update documentation based on lessons learned
5. Implement preventive measures for future
--- ---
@@ -152,3 +255,4 @@ Ready-to-use prompts for consistent Claude Project workflow:
**Last Updated**: June 2025 **Last Updated**: June 2025
**Current Stage**: Prototype Development **Current Stage**: Prototype Development
**Next Review**: July 2025 (Monthly documentation review)