From fe51b0877e62f8ae028bd4b6db015626e3ed9986 Mon Sep 17 00:00:00 2001 From: valorisa Date: Tue, 23 Jun 2026 10:41:34 +0200 Subject: [PATCH] ci: add markdownlint workflow + fix MD013/MD028/MD040 in READMEs --- .github/workflows/markdownlint.yml | 28 ++++++ .markdownlint.json | 9 ++ README.md | 131 ++++++++++++++++--------- README_FR.md | 148 ++++++++++++++++++++--------- 4 files changed, 227 insertions(+), 89 deletions(-) create mode 100644 .github/workflows/markdownlint.yml create mode 100644 .markdownlint.json diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml new file mode 100644 index 0000000..5b6c0f4 --- /dev/null +++ b/.github/workflows/markdownlint.yml @@ -0,0 +1,28 @@ +name: Markdown Lint + +on: + push: + branches: + - master + paths: + - '**.md' + pull_request: + branches: + - master + paths: + - '**.md' + +jobs: + markdownlint: + name: Lint Markdown files + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Run markdownlint + uses: DavidAnson/markdownlint-cli2-action@v17 + with: + globs: '**/*.md' + config: '.markdownlint.json' diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..ea929db --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,9 @@ +{ + "default": true, + "MD013": { "line_length": 120 }, + "MD029": { "style": "ordered" }, + "MD033": false, + "MD036": false, + "MD041": false, + "MD060": false +} diff --git a/README.md b/README.md index 3a75aca..41a2395 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,10 @@ But every single time, you waste precious minutes: This framework is the answer. > 💡 **What is an AI assistant, for beginners?** -> An AI assistant (like ChatGPT or Claude) is a software tool you can write to in plain language. You ask it a question or give it a task, and it generates a text response. Think of it as a very fast, very well-read writing partner — but one with no memory of you, no knowledge of your style, and a tendency to sound corporate by default. This framework fixes that. +> An AI assistant (like ChatGPT or Claude) is a software tool you can write to in plain language. You ask it a question +> or give it a task, and it generates a text response. Think of it as a very fast, very well-read writing partner — but +> one with no memory of you, no knowledge of your style, and a tendency to sound corporate by default. This framework +> fixes that. It gives you a **ready-to-use method** to: @@ -30,7 +33,8 @@ It gives you a **ready-to-use method** to: 3. **Maintain quality over time** (preventing the AI from drifting toward generic language), 4. **Fix mistakes** in a few minutes per month. -The result: a **digital assistant** that produces texts ready to send (or needing less than 2 minutes of touch-up), 100% in your style. +The result: a **digital assistant** that produces texts ready to send (or needing less than 2 minutes of touch-up), 100% +in your style. --- @@ -42,36 +46,44 @@ The result: a **digital assistant** that produces texts ready to send (or needin - **Anyone** who uses AI and is tired of generic, robotic responses. **No technical skills required.** -All you need is an account on an AI platform that supports the "Project" feature (Claude Pro or ChatGPT Plus), and about thirty of your own texts. +All you need is an account on an AI platform that supports the "Project" feature (Claude Pro or ChatGPT Plus), and about +thirty of your own texts. > 💡 **What is a "Project" feature?** -> Some AI platforms let you create a dedicated workspace called a "Project" (or similar). Inside this workspace, you can set permanent instructions that the AI will follow for every conversation — without you having to repeat them each time. Think of it as a "briefing sheet" permanently attached to your AI's memory. Claude Pro calls this "Projects"; ChatGPT Plus calls it "Custom Instructions" or "Projects" depending on the version. +> Some AI platforms let you create a dedicated workspace called a "Project" (or similar). Inside this workspace, you can +> set permanent instructions that the AI will follow for every conversation — without you having to repeat them each +> time. Think of it as a "briefing sheet" permanently attached to your AI's memory. Claude Pro calls this "Projects"; +> ChatGPT Plus calls it "Custom Instructions" or "Projects" depending on the version. --- ## 🧭 What you'll find in this repository > 💡 **What is a repository?** -> A repository (often called a "repo") is a folder hosted on GitHub that contains all the files for a project. GitHub is a website where developers (and increasingly non-developers) store, share, and collaborate on files. Think of it as a Google Drive, but built for code and text files, with version history included. - -| File / Folder | What it contains | -| ------------------------------------ | ------------------------------------------------------------------------------------------- | -| `templates/Prompt_Master.md` | The **Constitution**: the rules that govern your assistant (style, tone, forbidden phrases) | -| `templates/Meta-Prompt_Nettoyage.md` | The recipe to sort your texts and extract the 7 best examples | -| `templates/Golden_Dataset.md` | The **5 regression tests** to verify every month that the AI hasn't drifted | -| `templates/Quarantaine.md` | The file to log the AI's daily mistakes (zero friction) | -| `templates/Changelog.md` | The change log (to keep track of your configuration updates) | -| `docs/` | Complementary guides (glossary, quick start, architecture) | -| `examples/` | Concrete examples of emails and posts | +> A repository (often called a "repo") is a folder hosted on GitHub that contains all the files for a project. GitHub is +> a website where developers (and increasingly non-developers) store, share, and collaborate on files. Think of it as a +> Google Drive, but built for code and text files, with version history included. + +| File / Folder | What it contains | +| ------------------------------------ | -------------------------------------------------------------- | +| `templates/Prompt_Master.md` | The **Constitution**: style rules, tone, forbidden phrases | +| `templates/Meta-Prompt_Nettoyage.md` | Extracts the 7 best example texts from your collection | +| `templates/Golden_Dataset.md` | **5 regression tests** — monthly check against voice drift | +| `templates/Quarantaine.md` | Daily log of AI mistakes (zero friction, copy-paste only) | +| `templates/Changelog.md` | Change log — tracks every configuration update with dates | +| `docs/` | Complementary guides (glossary, quick start, architecture) | +| `examples/` | Concrete examples of emails and posts | > 💡 **What are `.md` files?** -> Files ending in `.md` are Markdown files — plain text files with light formatting (headings, bold, bullet points). You can open them with any text editor (Notepad, VS Code, etc.) or read them directly on GitHub, where they render beautifully. No special software is required. +> Files ending in `.md` are Markdown files — plain text files with light formatting (headings, bold, bullet points). You +> can open them with any text editor (Notepad, VS Code, etc.) or read them directly on GitHub, where they render +> beautifully. No special software is required. --- ### 📂 Full folder structure -``` +```text 📂 custom-ai-assistant-framework/ ├── 📄 README.md ├── 📄 LICENSE @@ -88,7 +100,7 @@ All you need is an account on an AI platform that supports the "Project" feature ├── 📄 Meta-Prompt_Nettoyage.md ├── 📄 Prompt_Master.md └── 📄 Quarantaine.md -``` +```text --- @@ -99,7 +111,8 @@ All you need is an account on an AI platform that supports the "Project" feature - **Recommended**: [Claude Pro](https://claude.ai) (the most advanced "Projects" interface). - **Alternative**: ChatGPT Plus ("Projects" or "Custom Instructions" feature). -> 💡 Both platforms require a paid subscription (approximately $20/month). Free plans exist but do not include the persistent "Project" feature, which is essential for this framework to work. +> 💡 Both platforms require a paid subscription (approximately $20/month). Free plans exist but do not include the +> persistent "Project" feature, which is essential for this framework to work. --- @@ -111,7 +124,9 @@ All you need is an account on an AI platform that supports the "Project" feature - Paste them all into a single text file, one block per text, separated by blank lines or numbered. > 💡 **Why 30 texts?** -> The AI needs enough examples to identify the patterns in *your* writing — your sentence length, your preferred transitions, your vocabulary, your level of formality. Ten texts is too few; a hundred is overkill. Thirty is the practical sweet spot that gives the AI enough material to work with without overwhelming it. +> The AI needs enough examples to identify the patterns in *your* writing — your sentence length, your preferred +> transitions, your vocabulary, your level of formality. Ten texts is too few; a hundred is overkill. Thirty is the +> practical sweet spot that gives the AI enough material to work with without overwhelming it. --- @@ -120,20 +135,28 @@ All you need is an account on an AI platform that supports the "Project" feature - Open `templates/Meta-Prompt_Nettoyage.md`. - Copy its entire content. - In the AI, start a new conversation, **paste this prompt**, then **attach your file of 30–50 texts**. -- The AI will select the 7 texts most representative of your voice, and for each one generate a **Stylistic Identity Card** (DNA + Anti-patterns). +- The AI will select the 7 texts most representative of your voice, and for each one generate a **Stylistic Identity +Card** (DNA + Anti-patterns). - Save the result in a file called `Exemples.md`. **This is your Case Law.** > 💡 **What is a "prompt"?** -> A prompt is simply the instruction or question you give to an AI. It can be one sentence ("Write me a sales email") or a very detailed document (like the templates in this framework). The more precise and structured the prompt, the more predictable and useful the AI's response. - +> A prompt is simply the instruction or question you give to an AI. It can be one sentence ("Write me a sales email") or +> a very detailed document (like the templates in this framework). The more precise and structured the prompt, the more +> predictable and useful the AI's response. +> > 💡 **What is a "Stylistic Identity Card"?** -> When the AI analyzes your texts, it produces a short profile of each one: what makes it sound like *you* (your "DNA" — recurring phrases, rhythm, tone) and what to avoid ("Anti-patterns" — things that would signal the text was written by someone else or by a generic AI). Think of it as a writing fingerprint. - +> When the AI analyzes your texts, it produces a short profile of each one: what makes it sound like *you* (your "DNA" — +> recurring phrases, rhythm, tone) and what to avoid ("Anti-patterns" — things that would signal the text was written by +> someone else or by a generic AI). Think of it as a writing fingerprint. +> > 💡 **What is "Case Law"?** -> This metaphor borrows from law: just as judges refer to past rulings to ensure consistency, your AI will refer to your best example texts to ensure all future outputs stay consistent with your voice. Your `Exemples.md` file acts as the precedents. - +> This metaphor borrows from law: just as judges refer to past rulings to ensure consistency, your AI will refer to your +> best example texts to ensure all future outputs stay consistent with your voice. Your `Exemples.md` file acts as the +> precedents. +> > 💡 **How do you "attach a file" to an AI?** -> Most AI platforms with a "Project" or chat interface have a paperclip icon or an "Upload" button that lets you attach a file to your message. The AI will read its contents and use them as context for its response. +> Most AI platforms with a "Project" or chat interface have a paperclip icon or an "Upload" button that lets you attach +> a file to your message. The AI will read its contents and use them as context for its response. --- @@ -147,7 +170,9 @@ All you need is an account on an AI platform that supports the "Project" feature - Save this personalized file. > 💡 **Why call it a "Constitution"?** -> Just like a country's constitution is the supreme document that all laws must respect, your `Prompt_Master.md` is the supreme document that governs everything your AI says. Every response it generates will be filtered through these rules. It's the single most important file in the whole framework. +> Just like a country's constitution is the supreme document that all laws must respect, your `Prompt_Master.md` is the +> supreme document that governs everything your AI says. Every response it generates will be filtered through these +> rules. It's the single most important file in the whole framework. --- @@ -159,10 +184,15 @@ All you need is an account on an AI platform that supports the "Project" feature - **You're done!** Start asking questions. The AI will respond in your voice. > 💡 **What are "system instructions"?** -> System instructions are a special field in a Project where you write instructions that the AI silently applies to every single conversation within that project — without you having to repeat them. It's the invisible briefing that runs in the background at all times. This is fundamentally different from typing instructions in a normal chat message. - +> System instructions are a special field in a Project where you write instructions that the AI silently applies to +> every single conversation within that project — without you having to repeat them. It's the invisible briefing that +> runs in the background at all times. This is fundamentally different from typing instructions in a normal chat +> message. +> > 💡 **What is a "knowledge base"?** -> In Claude's Projects interface, the knowledge base is a document storage area where you upload reference files. The AI can access these files during any conversation in the project, as if they were always open on its desk. This is where you put your `Exemples.md` so the AI always has your writing samples at hand. +> In Claude's Projects interface, the knowledge base is a document storage area where you upload reference files. The AI +> can access these files during any conversation in the project, as if they were always open on its desk. This is where +> you put your `Exemples.md` so the AI always has your writing samples at hand. --- @@ -176,10 +206,14 @@ To make sure your assistant stays faithful over time — AI platforms update sil - If a test fails, adjust your Master Prompt or your Examples (see `docs/guide-de-demarrage.md`). > 💡 **What is a "regression test"?** -> In software development, a regression test checks that something which used to work still works after a change. Here, the idea is the same: once a month, you run 5 specific writing scenarios through your AI to verify it still sounds like you. If it starts sounding generic or corporate again, you know the configuration needs a tune-up. - +> In software development, a regression test checks that something which used to work still works after a change. Here, +> the idea is the same: once a month, you run 5 specific writing scenarios through your AI to verify it still sounds +> like you. If it starts sounding generic or corporate again, you know the configuration needs a tune-up. +> > 💡 **What does "AI drift" mean?** -> AI platforms are updated regularly by their developers. These updates can subtly change how the AI interprets instructions, which may cause it to gradually sound less like you and more generic. "Drift" is this slow, silent deviation from your intended voice. The monthly test is your early-warning system. +> AI platforms are updated regularly by their developers. These updates can subtly change how the AI interprets +> instructions, which may cause it to gradually sound less like you and more generic. "Drift" is this slow, silent +> deviation from your intended voice. The monthly test is your early-warning system. --- @@ -189,14 +223,19 @@ It will happen occasionally. Here's what to do: - **Correct the text manually** before sending it (professional standards apply). - **Copy-paste** the failed prompt and response into `Quarantaine.md` (on your local computer). -- At the end of the month, run a **"Doctor session"**: give the AI your `Quarantaine.md` file and ask it to identify the 3 changes to make to your configuration. +- At the end of the month, run a **"Doctor session"**: give the AI your `Quarantaine.md` file and ask it to identify the +3 changes to make to your configuration. - Log those changes in `Changelog.md` and update your files accordingly. > 💡 **What is a "Quarantine" file?** -> It's a simple running log where you paste examples of the AI's mistakes — like a notepad for bugs. Zero friction: no formatting required, just copy-paste. At the end of the month, this raw collection of failures becomes the input for a structured improvement session. The AI itself helps you diagnose what went wrong and how to fix it. - +> It's a simple running log where you paste examples of the AI's mistakes — like a notepad for bugs. Zero friction: no +> formatting required, just copy-paste. At the end of the month, this raw collection of failures becomes the input for a +> structured improvement session. The AI itself helps you diagnose what went wrong and how to fix it. +> > 💡 **What is a "Changelog"?** -> A changelog is a running record of every change made to a configuration or software, with dates and descriptions. It lets you roll back if a change made things worse, and helps you remember what you tried. Think of it as a diary for your AI setup. +> A changelog is a running record of every change made to a configuration or software, with dates and descriptions. It +> lets you roll back if a change made things worse, and helps you remember what you tried. Think of it as a diary for +> your AI setup. --- @@ -212,10 +251,13 @@ It will happen occasionally. Here's what to do: This repository is licensed under the MIT License (see `LICENSE`). You are free to use it, modify it, and redistribute it. -**Use it at your own risk**: this system is an assistant, not a substitute for your professional judgment. Always read texts before sending them. +**Use it at your own risk**: this system is an assistant, not a substitute for your professional judgment. Always read +texts before sending them. > 💡 **What is an MIT license?** -> The MIT license is one of the most permissive open-source licenses. It essentially means: "Do whatever you want with this — use it, modify it, sell it — just keep the original copyright notice." It imposes almost no restrictions on the user. +> The MIT license is one of the most permissive open-source licenses. It essentially means: "Do whatever you want with +> this — use it, modify it, sell it — just keep the original copyright notice." It imposes almost no restrictions on the +> user. --- @@ -227,10 +269,13 @@ This framework is the result of rigorous stress-testing, designed to be **pragma ## 📬 Contact -If you have questions, suggestions, or want to adapt this framework to a specific industry, feel free to open an **issue** on this repository or contact the author via GitHub ([@valorisa](https://github.com/valorisa)). +If you have questions, suggestions, or want to adapt this framework to a specific industry, feel free to open an +**issue** on this repository or contact the author via GitHub ([@valorisa](https://github.com/valorisa)). > 💡 **What is an "issue" on GitHub?** -> An issue is a comment thread attached to a repository. It's the standard way to report a bug, ask a question, or suggest a feature. You need a (free) GitHub account to open one. Think of it as a public forum attached directly to the project. +> An issue is a comment thread attached to a repository. It's the standard way to report a bug, ask a question, or +> suggest a feature. You need a (free) GitHub account to open one. Think of it as a public forum attached directly to +> the project. --- diff --git a/README_FR.md b/README_FR.md index 63788e8..503ef45 100644 --- a/README_FR.md +++ b/README_FR.md @@ -5,7 +5,8 @@ [![Type: Framework](https://img.shields.io/badge/Type-Framework-blue)](https://github.com/valorisa/Custom-AI-Assistant-Framework) [![Made with Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](https://daringfireball.net/projects/markdown/) -**Un cadre structuré pour configurer un assistant IA qui parle comme vous – sans bullshit, sans temps de chauffe, sans dérive.** +**Un cadre structuré pour configurer un assistant IA qui parle comme vous – sans bullshit, sans temps de chauffe, sans +dérive.** --- @@ -21,10 +22,16 @@ Mais à chaque fois, vous perdez un temps précieux à : Ce framework est la réponse. > 💡 **C'est quoi un assistant IA, pour les néophytes ?** -> Un assistant IA (comme ChatGPT ou Claude) est un logiciel auquel vous écrivez en langage naturel — comme un SMS ou un email. Vous lui posez une question ou lui confiez une tâche, et il génère une réponse textuelle. Imaginez un collaborateur ultra-rapide et ultra-cultivé… mais qui n'a aucune mémoire de vous, ne connaît pas votre style, et tend naturellement vers un langage lisse et impersonnel. Ce framework corrige précisément ça. - +> Un assistant IA (comme ChatGPT ou Claude) est un logiciel auquel vous écrivez en langage naturel — comme un SMS ou un +> email. Vous lui posez une question ou lui confiez une tâche, et il génère une réponse textuelle. Imaginez un +> collaborateur ultra-rapide et ultra-cultivé… mais qui n'a aucune mémoire de vous, ne connaît pas votre style, et tend +> naturellement vers un langage lisse et impersonnel. Ce framework corrige précisément ça. +> > 💡 **C'est quoi un "LLM" ?** -> LLM signifie *Large Language Model* — en français, "grand modèle de langage". C'est le nom technique des IA conversationnelles comme Claude, ChatGPT ou Gemini. Ce sont des programmes entraînés sur d'énormes quantités de textes pour apprendre à prédire et générer du langage humain. Dans ce README, "IA", "LLM" et "assistant IA" désignent la même chose. +> LLM signifie *Large Language Model* — en français, "grand modèle de langage". C'est le nom technique des IA +> conversationnelles comme Claude, ChatGPT ou Gemini. Ce sont des programmes entraînés sur d'énormes quantités de textes +> pour apprendre à prédire et générer du langage humain. Dans ce README, "IA", "LLM" et "assistant IA" désignent la même +> chose. Il vous offre une **méthode clé en main** pour : @@ -33,7 +40,8 @@ Il vous offre une **méthode clé en main** pour : 3. **Maintenir la qualité dans le temps** (sans que l'IA dérive vers un ton générique), 4. **Corriger les erreurs** en quelques minutes par mois. -Le résultat : un **assistant numérique** qui produit des textes prêts à l'envoi (ou avec une retouche de moins de 2 minutes), 100 % dans votre style. +Le résultat : un **assistant numérique** qui produit des textes prêts à l'envoi (ou avec une retouche de moins de 2 +minutes), 100 % dans votre style. --- @@ -45,36 +53,45 @@ Le résultat : un **assistant numérique** qui produit des textes prêts à l'en - **Toute personne** qui utilise une IA et en a marre des réponses génériques. **Aucune compétence technique n'est requise.** -Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude Pro ou ChatGPT Plus) et d'une trentaine de vos propres textes. +Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude Pro ou ChatGPT Plus) et d'une trentaine de +vos propres textes. > 💡 **C'est quoi la fonctionnalité "Projet" ?** -> Certaines plateformes IA vous permettent de créer un espace de travail dédié appelé "Projet". À l'intérieur, vous définissez des instructions permanentes que l'IA appliquera à toutes vos conversations — sans que vous ayez à les répéter à chaque fois. Imaginez une fiche de briefing collée en permanence dans la mémoire de votre assistant. Sur Claude Pro, ça s'appelle "Projects" ; sur ChatGPT Plus, c'est "Custom Instructions" ou "Projects" selon la version. +> Certaines plateformes IA vous permettent de créer un espace de travail dédié appelé "Projet". À l'intérieur, vous +> définissez des instructions permanentes que l'IA appliquera à toutes vos conversations — sans que vous ayez à les +> répéter à chaque fois. Imaginez une fiche de briefing collée en permanence dans la mémoire de votre assistant. Sur +> Claude Pro, ça s'appelle "Projects" ; sur ChatGPT Plus, c'est "Custom Instructions" ou "Projects" selon la version. --- ## 🧭 Ce que vous trouverez dans ce dépôt > 💡 **C'est quoi un "dépôt" (repository) ?** -> Un dépôt (ou "repo") est un dossier hébergé sur GitHub qui contient tous les fichiers d'un projet. GitHub est un site web où développeurs (et de plus en plus, des non-développeurs) stockent, partagent et collaborent sur des fichiers. Pensez-y comme un Google Drive, mais conçu pour les fichiers texte et le code, avec un historique de toutes les modifications. - -| Fichier / Dossier | Contenu | -| ------------------------------------ | -------------------------------------------------------------------------------------------- | -| `templates/Prompt_Master.md` | La **Constitution** : les règles de votre assistant (style, ton, interdictions) | -| `templates/Meta-Prompt_Nettoyage.md` | La recette pour trier vos textes et en extraire les 7 meilleurs exemples | -| `templates/Golden_Dataset.md` | Les **5 tests de régression** pour vérifier chaque mois que l'IA ne dérive pas | -| `templates/Quarantaine.md` | Le fichier pour noter les erreurs de l'IA au quotidien (friction zéro) | -| `templates/Changelog.md` | Le journal des modifications (pour garder une trace de vos évolutions) | -| `docs/` | Des guides complémentaires (glossaire, démarrage, architecture) | -| `examples/` | Des exemples concrets d'emails et de posts | +> Un dépôt (ou "repo") est un dossier hébergé sur GitHub qui contient tous les fichiers d'un projet. GitHub est un site +> web où développeurs (et de plus en plus, des non-développeurs) stockent, partagent et collaborent sur des fichiers. +> Pensez-y comme un Google Drive, mais conçu pour les fichiers texte et le code, avec un historique de toutes les +> modifications. + +| Fichier / Dossier | Contenu | +| ------------------------------------ | --------------------------------------------------------------- | +| `templates/Prompt_Master.md` | La **Constitution** : style, ton, interdictions | +| `templates/Meta-Prompt_Nettoyage.md` | Extrait les 7 meilleurs exemples de votre collection | +| `templates/Golden_Dataset.md` | **5 tests de régression** — contrôle mensuel anti-dérive | +| `templates/Quarantaine.md` | Journal des erreurs de l'IA au quotidien (friction zéro) | +| `templates/Changelog.md` | Journal des modifications daté de votre configuration | +| `docs/` | Guides complémentaires (glossaire, démarrage, architecture) | +| `examples/` | Exemples concrets d'emails et de posts | > 💡 **C'est quoi des fichiers `.md` ?** -> Les fichiers `.md` sont des fichiers Markdown — des fichiers texte simples avec une mise en forme légère (titres, gras, listes à puces). Vous pouvez les ouvrir avec n'importe quel éditeur de texte (Bloc-notes, VS Code, etc.) ou les lire directement sur GitHub, où ils s'affichent joliment mis en page. Aucun logiciel spécial n'est nécessaire. +> Les fichiers `.md` sont des fichiers Markdown — des fichiers texte simples avec une mise en forme légère (titres, +> gras, listes à puces). Vous pouvez les ouvrir avec n'importe quel éditeur de texte (Bloc-notes, VS Code, etc.) ou les +> lire directement sur GitHub, où ils s'affichent joliment mis en page. Aucun logiciel spécial n'est nécessaire. --- ### 📂 Arborescence complète -``` +```text 📂 custom-ai-assistant-framework/ ├── 📄 README.md ├── 📄 LICENSE @@ -91,7 +108,7 @@ Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude ├── 📄 Meta-Prompt_Nettoyage.md ├── 📄 Prompt_Master.md └── 📄 Quarantaine.md -``` +```text --- @@ -102,7 +119,9 @@ Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude - **Recommandé** : [Claude Pro](https://claude.ai) (interface « Projects » la plus aboutie). - **Alternative** : ChatGPT Plus (fonction « Projets » ou « Custom Instructions »). -> 💡 Les deux plateformes nécessitent un abonnement payant (environ 20 €/mois). Des versions gratuites existent, mais elles n'incluent pas la fonctionnalité "Projet" persistante, qui est indispensable au bon fonctionnement de ce framework. +> 💡 Les deux plateformes nécessitent un abonnement payant (environ 20 €/mois). Des versions gratuites existent, mais +> elles n'incluent pas la fonctionnalité "Projet" persistante, qui est indispensable au bon fonctionnement de ce +> framework. --- @@ -114,7 +133,10 @@ Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude - Collez-les dans un fichier texte (un bloc par texte, numérotés ou séparés par des lignes). > 💡 **Pourquoi 30 textes ?** -> L'IA a besoin d'un volume suffisant pour identifier les *patterns* (les récurrences) dans votre écriture — vos longueurs de phrases, vos tournures favorites, votre niveau de familiarité, votre façon de conclure. Dix textes, c'est trop peu ; cent, c'est superflu. Trente, c'est le point d'équilibre qui donne à l'IA assez de matière pour travailler efficacement. +> L'IA a besoin d'un volume suffisant pour identifier les *patterns* (les récurrences) dans votre écriture — vos +> longueurs de phrases, vos tournures favorites, votre niveau de familiarité, votre façon de conclure. Dix textes, c'est +> trop peu ; cent, c'est superflu. Trente, c'est le point d'équilibre qui donne à l'IA assez de matière pour travailler +> efficacement. --- @@ -123,20 +145,29 @@ Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude - Ouvrez `templates/Meta-Prompt_Nettoyage.md`. - Copiez son contenu intégral. - Dans l'IA, créez une nouvelle conversation, **collez ce prompt**, puis **attachez votre fichier de 30–50 textes**. -- L'IA va sélectionner les 7 textes les plus représentatifs de votre voix, et générer pour chacun une **Fiche d'Identité Stylistique** (ADN + Anti-pattern). +- L'IA va sélectionner les 7 textes les plus représentatifs de votre voix, et générer pour chacun une **Fiche d'Identité +Stylistique** (ADN + Anti-pattern). - Sauvegardez le résultat dans un fichier `Exemples.md`. **C'est votre Jurisprudence.** > 💡 **C'est quoi un "prompt" ?** -> Un prompt, c'est simplement l'instruction ou la question que vous donnez à une IA. Ça peut être une phrase ("Écris-moi un email de prospection") ou un document très détaillé (comme les templates de ce framework). Plus le prompt est précis et structuré, plus la réponse de l'IA est prévisible et utile. - +> Un prompt, c'est simplement l'instruction ou la question que vous donnez à une IA. Ça peut être une phrase ("Écris-moi +> un email de prospection") ou un document très détaillé (comme les templates de ce framework). Plus le prompt est +> précis et structuré, plus la réponse de l'IA est prévisible et utile. +> > 💡 **C'est quoi une "Fiche d'Identité Stylistique" ?** -> Quand l'IA analyse vos textes, elle produit un profil court pour chacun : ce qui le rend reconnaissable comme venant de *vous* (votre "ADN" — tournures récurrentes, rythme, ton) et ce qu'il faut éviter ("Anti-patterns" — ce qui signalerait qu'un autre personne ou une IA générique a écrit le texte). C'est votre empreinte digitale d'écriture. - +> Quand l'IA analyse vos textes, elle produit un profil court pour chacun : ce qui le rend reconnaissable comme venant +> de *vous* (votre "ADN" — tournures récurrentes, rythme, ton) et ce qu'il faut éviter ("Anti-patterns" — ce qui +> signalerait qu'un autre personne ou une IA générique a écrit le texte). C'est votre empreinte digitale d'écriture. +> > 💡 **C'est quoi la "Jurisprudence" ?** -> Cette métaphore vient du droit : comme les juges s'appuient sur des décisions passées pour garantir la cohérence, votre IA se référera à vos meilleurs exemples de textes pour s'assurer que toutes ses futures productions restent cohérentes avec votre voix. Votre fichier `Exemples.md` joue le rôle de ces décisions de référence. - +> Cette métaphore vient du droit : comme les juges s'appuient sur des décisions passées pour garantir la cohérence, +> votre IA se référera à vos meilleurs exemples de textes pour s'assurer que toutes ses futures productions restent +> cohérentes avec votre voix. Votre fichier `Exemples.md` joue le rôle de ces décisions de référence. +> > 💡 **Comment "attacher un fichier" à une IA ?** -> La plupart des plateformes IA disposent d'une icône en forme de trombone ou d'un bouton "Joindre un fichier" qui vous permet d'uploader un document directement dans la conversation. L'IA en lit le contenu et l'utilise comme contexte pour formuler sa réponse. +> La plupart des plateformes IA disposent d'une icône en forme de trombone ou d'un bouton "Joindre un fichier" qui vous +> permet d'uploader un document directement dans la conversation. L'IA en lit le contenu et l'utilise comme contexte +> pour formuler sa réponse. --- @@ -150,7 +181,9 @@ Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude - Sauvegardez ce fichier personnalisé. > 💡 **Pourquoi l'appeler la "Constitution" ?** -> Comme la Constitution d'un pays est le texte suprême auquel toutes les lois doivent se conformer, votre `Prompt_Master.md` est le document de référence qui gouverne tout ce que dit votre IA. Chaque réponse qu'elle génère sera filtrée à travers ces règles. C'est le fichier le plus important de tout le framework. +> Comme la Constitution d'un pays est le texte suprême auquel toutes les lois doivent se conformer, votre +> `Prompt_Master.md` est le document de référence qui gouverne tout ce que dit votre IA. Chaque réponse qu'elle génère +> sera filtrée à travers ces règles. C'est le fichier le plus important de tout le framework. --- @@ -162,10 +195,16 @@ Il vous suffit d'un compte sur une IA avec fonctionnalité « Projet » (Claude - **C'est fini !** Vous pouvez commencer à poser des questions. L'IA répondra avec votre voix. > 💡 **C'est quoi les "instructions système" ?** -> Les instructions système sont un champ spécial dans un Projet où vous écrivez des directives que l'IA applique silencieusement à toutes les conversations de ce projet — sans que vous ayez à les répéter. C'est le briefing invisible qui tourne en arrière-plan en permanence. C'est fondamentalement différent d'un message que vous tapez dans la fenêtre de chat habituelle. - +> Les instructions système sont un champ spécial dans un Projet où vous écrivez des directives que l'IA applique +> silencieusement à toutes les conversations de ce projet — sans que vous ayez à les répéter. C'est le briefing +> invisible qui tourne en arrière-plan en permanence. C'est fondamentalement différent d'un message que vous tapez dans +> la fenêtre de chat habituelle. +> > 💡 **C'est quoi une "base de connaissances" ?** -> Dans l'interface Projects de Claude, la base de connaissances est un espace de stockage de documents. Les fichiers que vous y uploadez sont accessibles par l'IA lors de n'importe quelle conversation dans le projet, comme s'ils étaient toujours ouverts sur son bureau. C'est là que vous déposez votre `Exemples.md` pour que l'IA ait toujours vos textes de référence sous la main. +> Dans l'interface Projects de Claude, la base de connaissances est un espace de stockage de documents. Les fichiers que +> vous y uploadez sont accessibles par l'IA lors de n'importe quelle conversation dans le projet, comme s'ils étaient +> toujours ouverts sur son bureau. C'est là que vous déposez votre `Exemples.md` pour que l'IA ait toujours vos textes +> de référence sous la main. --- @@ -179,10 +218,16 @@ Pour être sûr que votre assistant reste fidèle dans le temps (les IA évoluen - Si un test échoue, ajustez votre Prompt Master ou vos Exemples (voir `docs/guide-de-demarrage.md`). > 💡 **C'est quoi un "test de régression" ?** -> En développement logiciel, un test de régression vérifie qu'une fonctionnalité qui marchait avant marche toujours après une modification. Ici, le principe est identique : une fois par mois, vous soumettez 5 scénarios d'écriture précis à votre IA pour vérifier qu'elle sonne toujours comme vous. Si elle commence à sonner générique ou corporate, vous savez que la configuration a besoin d'un réglage. - +> En développement logiciel, un test de régression vérifie qu'une fonctionnalité qui marchait avant marche toujours +> après une modification. Ici, le principe est identique : une fois par mois, vous soumettez 5 scénarios d'écriture +> précis à votre IA pour vérifier qu'elle sonne toujours comme vous. Si elle commence à sonner générique ou corporate, +> vous savez que la configuration a besoin d'un réglage. +> > 💡 **C'est quoi la "dérive" d'une IA ?** -> Les plateformes IA sont régulièrement mises à jour par leurs développeurs. Ces mises à jour peuvent subtilement modifier la façon dont l'IA interprète vos instructions, la poussant progressivement vers un langage plus générique. La "dérive", c'est cet écart silencieux et graduel par rapport à votre voix souhaitée. Le test mensuel est votre système d'alerte précoce. +> Les plateformes IA sont régulièrement mises à jour par leurs développeurs. Ces mises à jour peuvent subtilement +> modifier la façon dont l'IA interprète vos instructions, la poussant progressivement vers un langage plus générique. +> La "dérive", c'est cet écart silencieux et graduel par rapport à votre voix souhaitée. Le test mensuel est votre +> système d'alerte précoce. --- @@ -192,14 +237,19 @@ C'est inévitable de temps en temps. Voici la marche à suivre : - **Corrigez le texte manuellement** pour l'envoyer (standard professionnel oblige). - **Copiez-collez** le prompt et la réponse ratée dans le fichier `Quarantaine.md` (en local). -- À la fin du mois, faites une **session « Médecin »** : donnez à l'IA votre fichier `Quarantaine.md` et demandez-lui d'identifier les 3 modifications à apporter à votre configuration. +- À la fin du mois, faites une **session « Médecin »** : donnez à l'IA votre fichier `Quarantaine.md` et demandez-lui +d'identifier les 3 modifications à apporter à votre configuration. - Notez ces modifications dans `Changelog.md` et ajustez vos fichiers. > 💡 **C'est quoi le fichier "Quarantaine" ?** -> C'est un simple carnet de bord où vous collez les exemples de ratés de l'IA — comme un post-it pour les bugs. Zéro mise en forme requise : copiez-collez brut. À la fin du mois, cette collection de défauts devient le matériau d'une session d'amélioration structurée. L'IA elle-même vous aide à diagnostiquer ce qui a cloché et comment y remédier. - +> C'est un simple carnet de bord où vous collez les exemples de ratés de l'IA — comme un post-it pour les bugs. Zéro +> mise en forme requise : copiez-collez brut. À la fin du mois, cette collection de défauts devient le matériau d'une +> session d'amélioration structurée. L'IA elle-même vous aide à diagnostiquer ce qui a cloché et comment y remédier. +> > 💡 **C'est quoi un "Changelog" ?** -> Un changelog (journal des modifications) est un historique daté de tous les changements apportés à une configuration ou un logiciel. Il vous permet de revenir en arrière si une modification a dégradé les résultats, et de vous souvenir de ce que vous avez essayé. Considérez-le comme le carnet de bord de votre configuration IA. +> Un changelog (journal des modifications) est un historique daté de tous les changements apportés à une configuration +> ou un logiciel. Il vous permet de revenir en arrière si une modification a dégradé les résultats, et de vous souvenir +> de ce que vous avez essayé. Considérez-le comme le carnet de bord de votre configuration IA. --- @@ -215,10 +265,13 @@ C'est inévitable de temps en temps. Voici la marche à suivre : Ce dépôt est sous licence MIT (voir `LICENSE`). Vous êtes libre de l'utiliser, le modifier, le redistribuer. -**Vous l'utilisez à vos risques et périls** : ce système est un assistant, pas un substitut à votre jugement professionnel. Relisez toujours les textes avant envoi. +**Vous l'utilisez à vos risques et périls** : ce système est un assistant, pas un substitut à votre jugement +professionnel. Relisez toujours les textes avant envoi. > 💡 **C'est quoi une licence MIT ?** -> La licence MIT est l'une des licences open source les plus permissives qui soient. Elle signifie en substance : "Faites ce que vous voulez avec ça — utilisez-le, modifiez-le, revendez-le — gardez juste la mention de copyright d'origine." Elle n'impose presque aucune contrainte à l'utilisateur. +> La licence MIT est l'une des licences open source les plus permissives qui soient. Elle signifie en substance : +> "Faites ce que vous voulez avec ça — utilisez-le, modifiez-le, revendez-le — gardez juste la mention de copyright +> d'origine." Elle n'impose presque aucune contrainte à l'utilisateur. --- @@ -230,10 +283,13 @@ Ce framework est le fruit d'un stress-test rigoureux, conçu pour être **pragma ## 📬 Contact -Si vous avez des questions, des suggestions, ou si vous souhaitez adapter ce framework à un métier spécifique, n'hésitez pas à ouvrir une **issue** sur ce dépôt ou à contacter l'auteur via GitHub ([@valorisa](https://github.com/valorisa)). +Si vous avez des questions, des suggestions, ou si vous souhaitez adapter ce framework à un métier spécifique, n'hésitez +pas à ouvrir une **issue** sur ce dépôt ou à contacter l'auteur via GitHub ([@valorisa](https://github.com/valorisa)). > 💡 **C'est quoi une "issue" sur GitHub ?** -> Une issue est un fil de discussion attaché à un dépôt. C'est la façon standard de signaler un bug, poser une question ou suggérer une amélioration. Il vous faut un compte GitHub (gratuit) pour en ouvrir une. Pensez-y comme un forum public directement intégré au projet. +> Une issue est un fil de discussion attaché à un dépôt. C'est la façon standard de signaler un bug, poser une question +> ou suggérer une amélioration. Il vous faut un compte GitHub (gratuit) pour en ouvrir une. Pensez-y comme un forum +> public directement intégré au projet. ---