3.1 KiB
GUIDE
This document provides a project overview, covering core information like the project name, a short description, its main purpose, value proposition, and target audience. It also lists key features, the core technologies employed, team members, and includes important links to relevant documentation, the source code repository, and the project management tool.
FORMAT
Title:
[Application/Website Name] app_ver: 0.1.0 doc_ver: A1
Short Description:
[Very brief (one-sentence) description of the application/website.]
Core Purpose:
[Brief (1-2 sentences) description of the problem the application/website solves and the value it provides.]
Target Audience:
[Brief description of the primary user group.]
Key Features Overview:
- [Feature Name List]
Core Technologies:
- [Technology Name List]
Key Document References:
Reference Projects:
[Link or brief description of similar projects (if any)]
Project Members:
Source Code Repository:
[Link to the source code repository (if any)]
Project Management Tool:
[Link to the project management tool (if any)]
CONTENT
Title: ZEE Quiz Application
app_ver: 1.0.0 doc_ver: A1
Short Description:
An interactive quiz platform where users can discover their personality profile and participate in a lucky draw to win prizes.
Core Purpose:
To create an engaging microsite where users answer a series of questions to discover their "vibe" profile, with an opportunity to win prizes through a lucky draw, while collecting user data and promoting the C2 brand.
Target Audience:
- Primary: Young adults and professionals interested in personality quizzes
- Secondary: Marketing team for user engagement and brand promotion
Key Features Overview:
- User registration and profile management
- Dynamic quiz with adaptive questions
- Personality profile generation
- Lucky draw with prize redemption
- Admin dashboard for content management
- Analytics and reporting
Core Technologies:
- Backend: Go 1.24.3 with DDD principles
- Database: PostgreSQL 14
- Frontend: HTMX
- Infrastructure: Docker, Docker Compose
- CI/CD: Gitea Actions
Key Document References:
- Architecture: System architecture and design decisions
- API Documentation: Detailed API specifications
- Deployment Guide: Setup and deployment instructions
- Development Workflow: Development processes and guidelines
- Security: Security policies and procedures
Reference Projects:
- ULFlow Golang Starter Kit: Base project structure
- C2 Brand Guidelines: Design and branding standards
Project Members:
- Product Owner: [Name]
- Tech Lead: [Name]
- Backend Developers: [Names]
- Frontend Developers: [Names]
- QA Engineers: [Names]
- DevOps: [Names]