GTA
/
training-academy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
training-academy/docs/README.md

3.1 KiB
Raw Permalink Blame History

📚 Documentation Index

Welcome to the Gooner Training Academy documentation! This directory contains all guides, references, and technical documentation for the application.

📖 Getting Started

Document Purpose Target Audience
INSTALLATION_GUIDE.md Setup instructions and system requirements New users, testers
TESTER_GUIDE.md Testing procedures and focus areas Beta testers, QA
README-DESKTOP.md Desktop-specific features and setup Desktop users

🎮 Feature Documentation

Document Purpose Target Audience
HYPNO-GALLERY-README.md Complete Hypno Gallery feature guide Users, developers

📋 Project Management

Document Purpose Target Audience
ROADMAP.md Development roadmap and future plans Stakeholders, developers
tasks.md Task lists and development todos Development team
organized-tasks.md Structured task organization Project managers
levels.md Game progression and level design Game designers
consequences.md Punishment system documentation Content designers

📦 Distribution & Release

Document Purpose Target Audience
DISTRIBUTION_SUMMARY.md Release packaging information Release managers
BETA_FEEDBACK_FORM.md Beta testing feedback template Beta testers

🗃️ Archives

The archive/ directory contains historical documentation and deprecated guides:

Document Status Notes
sprint1.md Archived First development sprint documentation
note.md Archived Development notes
GAME_MODE_CLEANUP_PLAN.md Archived Game mode refactoring plan
MEDIA_LIBRARY_CLEANUP_PLAN.md Archived Media system refactoring plan
DATA_LOSS_INCIDENT.md Archived Historical data loss incident report

🚀 Quick Navigation

For New Users:

  1. Start with INSTALLATION_GUIDE.md
  2. Review TESTER_GUIDE.md if participating in beta testing
  3. Check feature-specific documentation as needed

For Developers:

  1. Review ROADMAP.md for project direction
  2. Check tasks.md for current development priorities
  3. Consult feature documentation for implementation details

For Testers:

  1. Follow INSTALLATION_GUIDE.md for setup
  2. Use TESTER_GUIDE.md for testing procedures
  3. Submit feedback via BETA_FEEDBACK_FORM.md

Need help? Check the main README.md in the root directory for comprehensive application documentation and support resources.