Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.67 KB

index.md

File metadata and controls

27 lines (20 loc) · 1.67 KB

MarkLab — Documentation technique

Présentation

MarkLab est une application web de rédaction Markdown. Elle permet à un utilisateur de créer un compte, d’écrire des documents dans un éditeur à deux panneaux, de prévisualiser le résultat instantanément et de retrouver ses documents dans un espace privé.

Le projet est réalisé en tant que travail pratique individuel (TPI) CFC en blanc par Maksym Ptytsia.

Périmètre implémenté

  • Authentification par inscription, connexion et déconnexion.
  • Gestion de documents privés : création, consultation, modification, suppression et liste triée par dernière modification.
  • Saisie Markdown avec aperçu rendu, inversion des panneaux et mémorisation de la préférence d’affichage.
  • Sauvegarde automatique et export du document courant au format Markdown ou texte brut.

Lecture de la documentation

Document Contenu
Contexte et objectifs Besoin, utilisateurs et objectifs.
Planification Jalons effectivement réalisés.
Stack et architecture Technologies, structure et circulation des données.
Fonctionnalités Parcours utilisateur et comportement de l’interface.
Données et API Modèle relationnel et contrat HTTP.
Sécurité Contrôles de sécurité en place et limites.
Installation et exploitation Préparation de l’environnement et commandes.
Choix techniques et extraits Justification de choix et extraits représentatifs.