docs: consolidate repository guides and preserve audit history

2026-09-11 14:22:41 +02:00
parent 115441a409
commit 682a3028bb
404 changed files with 3402 additions and 2621 deletions
@@ -0,0 +1,270 @@
+# Jobjakt Glossary
+
+## Purpose
+
+Defines common terminology used throughout the application.
+
+This prevents ambiguity between product, UX, backend, frontend, and AI development.
+
+---
+
+# Core Terms
+
+## Job
+
+A job opportunity that a user may be interested in.
+
+Examples:
+
+- Software Engineer role.
+- Developer position.
+- Analyst role.
+
+A Job may exist before an application is submitted.
+
+---
+
+## Job Opportunity
+
+A specific role offered by a company.
+
+Contains:
+
+- Job title.
+- Company.
+- Description.
+- Location.
+- Salary information.
+- Requirements.
+
+---
+
+## Application
+
+A user's attempt to obtain a specific job.
+
+Relationship:
+
+Company
+
+↓
+
+Job Opportunity
+
+↓
+
+Application
+
+---
+
+## Application Stage
+
+The current state of an application.
+
+Examples:
+
+- Interested
+- Preparing
+- Applied
+- Screening
+- Interview
+- Offer
+- Rejected
+- Withdrawn
+
+---
+
+## Company
+
+An organisation offering employment.
+
+Companies are reusable entities.
+
+Example:
+
+A user may apply for:
+
+- Backend Developer
+- Frontend Developer
+
+at the same company.
+
+---
+
+# Career Workspace
+
+## Career Profile
+
+The user's professional source of truth.
+
+Contains:
+
+- Personal details.
+- Experience.
+- Education.
+- Skills.
+- Projects.
+- Certifications.
+- Achievements.
+
+The career profile is NOT a CV.
+
+It is the data used to create outputs.
+
+---
+
+## Master CV
+
+A generated representation of the Career Profile.
+
+Purpose:
+
+Provide a default CV.
+
+It can be customised but should originate from the Career Profile.
+
+---
+
+## CV Variant
+
+A different presentation of the same career information.
+
+Examples:
+
+- Software Engineer CV.
+- Management CV.
+- Academic CV.
+
+Variants should not duplicate career data.
+
+---
+
+## Tailored CV
+
+A CV adapted for a specific job application.
+
+Created from:
+
+Master Career Profile
+
+
+
+Job Description
+
+
+
+AI Suggestions
+
+---
+
+## CV Theme
+
+The visual design system used to render a CV.
+
+Contains:
+
+- Layout.
+- Typography.
+- Colours.
+- Spacing.
+- Components.
+
+Themes should not contain user data.
+
+---
+
+# AI Terms
+
+## AI Provider
+
+A service capable of generating AI responses.
+
+Examples:
+
+- OpenAI.
+- Gemini.
+- Claude.
+- Ollama.
+
+---
+
+## AI Generation
+
+Any content created or improved by AI.
+
+Examples:
+
+- CV bullet improvements.
+- Cover letters.
+- Job matching.
+
+---
+
+## AI Suggestion
+
+A recommendation from AI that requires user approval.
+
+---
+
+# Documents
+
+## Cover Letter
+
+A document explaining why a user is suitable for a specific role.
+
+---
+
+## Portfolio
+
+A collection of professional work.
+
+Examples:
+
+- Projects.
+- Case studies.
+- Publications.
+
+---
+
+# User
+
+A person using Jobjakt.
+
+---
+
+# Admin
+
+A user with system management permissions.
+
+Admins manage:
+
+- AI providers.
+- System settings.
+- Feature controls.
+
+---
+
+# Career Workspace
+
+The collection of tools supporting the user's career development.
+
+Includes:
+
+- Career Profile.
+- CV Builder.
+- Cover Letters.
+- Portfolio.
+- Future career tools.
+
+---
+
+# SaaS
+
+Future commercial version of Jobjakt.
+
+Potential features:
+
+- Subscriptions.
+- Premium themes.
+- AI limits.
+- Storage limits.