# Project Documentation Template

## Project Structure
```
project-name/
├── README.md              # Main project documentation
├── docs/                  # Detailed documentation
│   ├── setup.md          # Setup and installation steps
│   ├── configuration.md  # Configuration details
│   └── lessons-learned.md # Learning outcomes and challenges
├── scripts/              # Any automation scripts
└── resources/            # Additional resources and references
```

## Documentation Guidelines

### 1. Main README.md Structure
- Project Overview
- Environment Details
- Setup Steps (with status indicators ✅)
- Current Status
- Next Steps
- Configuration Details
- Additional Documentation Links

### 2. Required Documentation Files
- Setup documentation (detailed steps)
- Configuration details (with examples)
- Lessons learned & challenges
- Quick reference guides

### 3. Best Practices
- Use markdown formatting
- Include command examples
- Document both successes and failures
- Add status indicators (✅, ⚠️, ❌)
- Link related documents
- Include timestamps for major changes

### 4. Portfolio Considerations
- Clear project objectives
- Technical skills demonstrated
- Problems solved
- Best practices implemented
- Security considerations
- Documentation quality

## Prompt for Future Projects

When starting a new project, ask the assistant:

"I'm starting a new project [project-name]. Please help me:

1. Create the initial project structure
2. Set up documentation templates following the portfolio standard
3. Track progress with:
   - Setup steps and verification
   - Configuration details
   - Lessons learned
   - Best practices
   - Security considerations
   - Quick reference guides

Please maintain:
- Clear documentation
- Professional formatting
- Learning-focused approach
- Portfolio-ready structure
- Security best practices
- Practical examples and commands
- Troubleshooting guides

Current project status:
[Describe where you are in the project]

Next steps needed:
[Describe what you need help with]"