This document tracks all documentation artifacts in the TourGuideAI project, serving as a central reference for what documentation exists and where to find it.
| File | Purpose | Update Frequency |
|---|---|---|
docs/pics/flowchart/.mermaidworkflow |
Visual representation of project workflow | When workflow process changes |
docs/pics/flowchart/.mermaidfilesmap |
Visual representation of documentation relationships | When document structure changes |
| File | Purpose | Update Frequency |
|---|---|---|
docs/project_lifecycle/process_monitors/records/project.workflow-checklists.md |
Checklists for tracking workflow completion | At phase start and when procedures are finished |
docs/project.document-inventory.md |
This file - inventory of all documentation | When documentation is added or modified |
docs/project_lifecycle/process_monitors/records/project.phase-signoff.md |
Formal phase completion verification records | At phase completion |
docs/project_lifecycle/process_monitors/plans/project.phase6-beta-release-plan.md |
Phase 6 beta release plan | At phase start |
docs/project_lifecycle/process_monitors/plans/project.phase7-post-beta-enhancements-plan.md |
Phase 7 post-beta enhancements plan | At phase start |
docs/project_lifecycle/process_monitors/plans/project.phase8-completion-summary.md |
Phase 8 completion documentation | At Phase 8 completion |
docs/project_lifecycle/process_monitors/implementation_summary.md |
Summary of implementation progress | When implementation status changes |
docs/project_lifecycle/version_control/records/project.versions.md |
Version history and release notes | After version completion |
docs/project_lifecycle/version_control/records/project.beta.0.5.0-1.release-checklist.md |
Checklist for beta release deployment | During beta release preparation |
docs/project_lifecycle/version_control/records/project.beta.0.5.0-1.beta-tester-guide.md |
Guide for beta testers | Before beta release and when beta program changes |
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.overall-plan.md |
Refactoring categorization and approach | Before refactoring, quarterly review |
docs/project_lifecycle/knowledge/project.lessons.md |
Centralized location for all project lessons | After resolving challenges or insights |
| File | Purpose | Update Frequency |
|---|---|---|
docs/project_lifecycle/deployment/pipelines/project.deployment-pipeline.md |
Deployment process documentation | Before production release |
docs/project_lifecycle/deployment/plans/project.deployment-pipeline-plan.md |
Detailed deployment strategy | Before deployment pipeline implementation |
docs/project_lifecycle/deployment/plans/project.performance-optimization-plan.md |
Performance strategy and targets | Before optimization work |
docs/project_lifecycle/deployment/plans/project.performance-implementation-plan.md |
Implementation details for performance | Before performance feature implementation |
docs/project_lifecycle/deployment/plans/project.cdn-implementation-plan.md |
CDN implementation strategy with CI/CD integration | Updated with CDN implementation progress |
docs/project_lifecycle/deployment/records/project.cdn-implementation-summary.md |
Summary of implemented CDN components | When CDN implementation changes |
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.cdn-plan.md |
Plan for CDN code refactoring | Before CDN refactoring work |
docs/project_lifecycle/code_and_project_structure_refactors/records/project.refactors.cdn-completed.md |
Documentation of completed CDN refactors | After CDN refactoring |
scripts/run-security-audit.js |
Script for running security scans with OWASP ZAP or in mock mode | When security scanning process changes |
scripts/deploy-mvp.sh |
Optimized MVP deployment script with security checks, test validation, and multi-platform support | When MVP deployment process changes |
scripts/deploy-to-cdn.js |
Script for deploying assets to CDN | When CDN deployment process changes |
| File | Purpose | Update Frequency |
|---|---|---|
deployment/production/docker-compose.yml |
Production Docker stack configuration | When production services change |
deployment/production/Dockerfile.frontend |
Frontend production Docker image | When frontend build process changes |
deployment/production/Dockerfile.backend |
Backend production Docker image | When backend build process changes |
deployment/production/nginx.conf |
Production Nginx configuration with security hardening | When web server configuration changes |
deployment/production/prometheus.yml |
Monitoring and metrics configuration | When monitoring requirements change |
deployment/production/deploy.sh |
Zero-downtime deployment script | When deployment process changes |
deployment/production/README.md |
Comprehensive production deployment guide | When production infrastructure changes |
docs/project_lifecycle/deployment/security/project.security-hardening-checklist.md |
Comprehensive security hardening checklist | Before production deployment |
| File | Purpose | Update Frequency |
|---|---|---|
docs/project_lifecycle/all_tests/plans/project.tests.frontend-plan.md |
Comprehensive frontend testing strategy | When frontend test approach changes |
docs/project_lifecycle/all_tests/plans/project.tests.backend-plan.md |
Comprehensive backend testing strategy | When backend test approach changes |
docs/project_lifecycle/all_tests/plans/project.test.stabilization-plan.md |
Test stabilization implementation plan | During test improvement phases |
docs/project_lifecycle/all_tests/results/project.test-execution-results.md |
Test execution status and next steps | After each test run |
docs/project_lifecycle/all_tests/results/test-results-summary.md |
Summary of test results | After test completion |
docs/project_lifecycle/all_tests/results/project.tests.frontend-results-template.md |
Template for frontend test execution results | Used to create date-specific result files |
docs/project_lifecycle/all_tests/results/project.tests.backend-results-template.md |
Template for backend test execution results | Used to create date-specific result files |
docs/project_lifecycle/all_tests/results/coverage-report.md |
Test coverage metrics and trends | After each test run |
docs/project_lifecycle/all_tests/references/project.test-scenarios.md |
Detailed test scenarios with metrics | Before feature implementation |
docs/project_lifecycle/all_tests/references/project.test-user-story.md |
Mock user journeys for testing | Before feature implementation |
docs/project_lifecycle/all_tests/references/test-user-stories.md |
User stories for test scenario generation | Updated as features evolve |
docs/project_lifecycle/all_tests/references/project.tests.test-patterns.md |
Standard test patterns and conventions | When test patterns evolve |
docs/project_lifecycle/all_tests/references/project.tests.mock-strategies.md |
Documentation of mocking approaches for services | When mock strategies change |
docs/project_lifecycle/all_tests/references/project.test_organization.md |
Guide to test organization in the project | When test structure changes |
docs/project_lifecycle/all_tests/results/stability-test/README.md |
Information about stability test results | When stability test structure changes |
docs/project_lifecycle/all_tests/results/sync-service/README.md |
Information about SyncService test results | When SyncService test structure changes |
docs/project_lifecycle/all_tests/results/user-journey/README.md |
Information about user journey test results | When user journey test structure changes |
docs/project_lifecycle/all_tests/results/security-reports/README.md |
Information about security scanning and reports | When security scanning process changes |
docs/project_lifecycle/all_tests/README.md |
Main test documentation overview | When test structure changes |
tests/README.md |
Main test suite documentation | When test structure changes |
tests/smoke/README.md |
Smoke tests documentation | When smoke tests change |
tests/cross-browser/README.md |
Cross-browser tests documentation | When cross-browser tests change |
tests/load/README.md |
Load tests documentation | When load tests change |
tests/security/README.md |
Security tests documentation | When security tests change |
tests/all_tests/README.md |
All tests documentation including stability tests | When stability tests change |
tests/config/README.md |
Test configuration documentation | When test configuration changes |
| File | Purpose | Update Frequency |
|---|---|---|
tests/config/jest/frontend.config.js |
Jest configuration for frontend tests | When frontend test setup changes |
tests/config/jest/backend.config.js |
Jest configuration for backend tests | When backend test setup changes |
tests/config/jest/integration.config.js |
Jest configuration for integration tests | When integration test setup changes |
tests/config/mocks/componentMocks.js |
Standardized component mocks for testing | When component structure changes |
tests/config/mocks/serviceMocks.js |
Comprehensive service mocks for testing | When service interfaces change |
| File | Purpose | Update Frequency |
|---|---|---|
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.test-driven.md |
Planning for test-driven refactoring | Before refactoring |
docs/project_lifecycle/code_and_project_structure_refactors/records/project.refactors.test-driven-completed.md |
Documentation of completed test-driven refactors | After refactoring |
docs/project_lifecycle/code_and_project_structure_refactors/references/refactoring-patterns.md |
Reference patterns for improving testability | Updated as patterns evolve |
| File | Purpose | Update Frequency |
|---|---|---|
src/contexts/AuthContext.js |
Authentication state management implementation | When authentication features change |
src/contexts/NotificationContext.js |
Notification system implementation | When notification features change |
src/contexts/README.md |
Overview of React contexts in the application | When context structure changes |
| File | Purpose | Update Frequency |
|---|---|---|
src/components/Navbar.js |
Main navigation component implementation | When navigation features change |
src/components/Navbar.css |
Navbar styling and responsive design | When navigation UI changes |
| File | Purpose | Update Frequency |
|---|---|---|
docs/project_lifecycle/version_control/records/project.rc1.1.0.0.release-plan.md |
Release Candidate 1 planning documentation | During RC1 phase |
docs/project_lifecycle/version_control/records/project.rc2.1.0.0.release-plan.md |
Release Candidate 2 planning documentation | During RC2 phase |
| File | Purpose | Update Frequency |
|---|---|---|
docs/prototype/user_profile.json |
Prototype data for user profiles | When UI prototypes change |
docs/prototype/chat_page.json |
Prototype data for chat interface | When UI prototypes change |
docs/prototype/map_page_elements.json |
Prototype data for map visualization | When UI prototypes change |
| File | Purpose | Update Frequency |
|---|---|---|
docs/pics/flowchart/README.md |
Information about project diagrams and how to use them | When diagram structure changes |
docs/pics/screenshots/README.md |
Information about project screenshots | When screenshot collection changes |
docs/pics/flowchart/project_documentation_map.svg |
SVG visualization of documentation structure | When documentation structure changes |
docs/pics/flowchart/project_workflow.png |
PNG image of project workflow | When workflow process changes |
docs/project_lifecycle/code_and_project_structure_refactors/references/code-review-checklist.md |
Standard for code reviews | Reference during review |
docs/project_lifecycle/version_control/references/version-control.md |
Versioning conventions | Reference during releases |
docs/project_lifecycle/code_and_project_structure_refactors/references/dependencies-tracking.md |
Component dependency management | Update with architectural changes |
docs/project_lifecycle/code_and_project_structure_refactors/references/whats-code-review-looking-for.md |
Google's code review guide | Reference during reviews |
.github/workflows/ci-cd.yml |
GitHub Actions CI/CD workflow definition | When deployment processes change |
The following files were removed during Phase 8 cleanup and their functionality has been integrated into other documents:
deployment-checklist.md→ Integrated into production deployment filesdeployment-environment-setup.md→ Replaced bydeployment/production/configuration filesdocs/project_lifecycle/version_control/records/project.1.0.0-RC2-release-plan.md→ Superseded byproject.rc2.1.0.0.release-plan.mddocs/project_lifecycle/all_tests/plans/project.test-stabilization-plan.md→ Replaced byproject.test.stabilization-plan.mddocs/project_lifecycle/version_control/records/project.1.0.0-RC2-deployment-readiness-summary.md→ Integrated into Phase 8 completion summarydocs/project_lifecycle/version_control/records/project.phase8-completion-summary.md→ Moved todocs/project_lifecycle/process_monitors/plans/project.phase8-completion-summary.md
-
When creating a new document:
- Check this inventory to see if a similar document already exists
- Use consistent naming conventions (
project.category-purpose.md) - Update this inventory to include the new document
-
When updating a document:
- Ensure changes align with the stated purpose of the document
- Update any linked or related documents to maintain consistency
-
Document review should be performed:
- At the end of each development phase
- When making significant architectural changes
- Before release milestones
-
Production deployment documentation should be updated:
- When infrastructure configuration changes
- After security hardening updates
- When monitoring or alerting setup changes