SPECS for DEVELOPERS
We applied a PROMPT to francAIs OUTLINE (see previous post) to drive ChatGPT to generate the francAIs SPECS for DEVELOPERS.
Abstract of the PROMPT applied to the OUTLINE to prepare for VIBE CODING:
- The Prompt was designed to generate from the OUTLINE of the francAIs PROTOTYPE a compilation of all findings into comprehensive, developer-ready detailed specifications for Ruby on Rails, PostgreSQL, and Bootstrap, including functional and technical requirements, architecture and system design decisions, user flows, database schema and data models, data handling and validation rules, key UI screen descriptions, error handling strategies, and a complete testing plan.
Then ChatGPT generated a 22-page SPECS for DEVELOPERS with 10 sections. Examples of some sections below:
4.1 Home Page (Landing)
- Route: GET / → PagesController#home
- Content:
- Logo “francAIs” (simple text or image).
- One-sentence tagline: e.g. L’application minimaliste pour améliorer votre français écrit et oral.
- 3 bullet points:
- Évaluation CEFR automatique
- Modules simples et guidés
- 10 modules gratuits sur 30 jours
- Buttons:
- “S’inscrire” → Devise sign-up
- “Se connecter” → Devise login
- etc
5.1 users Table
- From Devise:
- email, encrypted_password, etc.
- Custom fields:
- verification_code :string
- verified_at :datetime
- cefr_level_id :integer (FK to levels, nullable)
- etc
7.1 Shared UI Elements
Navbar (Logged-in)
- Left: Logo “francAIs” (click → / or stays on same page).
- Center: Modules dropdown:
- Module 1 – Citation du jour
- Module 2 – Expression écrite
- Module 3 – Vocabulaire
- Right:
- Text: Modules restants : <modules_remaining>
- Text: Niveau : <level_code || "—">
- Link: “Mon profil”
- Link: “Déconnexion”
- Etc
_____________________________________
7.3 Module 2 – Expression écrite
Result Cards (in order)
- Card: Niveau CEFR
- Badge: e.g. “B1”
- Short explanation.
- Card: Analyse grammaticale
- Card: Analyse du vocabulaire
- Card: Analyse orthographique
- Card: Organisation des idées
- Card: Texte avec fautes marquées
- Learner’s text with errors highlighted.
- Card: Suggestions d’amélioration
- Card: Texte corrigé
- Card: Texte réécrit au niveau supérieur
etc
_____________________________________
8. AI Integration Details
8.1 General Rules
- Use chat completion with system + user messages.
- All output in French, except where translation is explicitly requested.
- Complexity of language and grammar:
- Adapted to CEFR level <LEVEL> for situation texts, analyses, and examples.
- Module 2 rewritten text:
- Generated at one level higher than evaluated level, if possible.
- etc
_____________________________________
