Documentation

Lire et chercher la documentation du projet, tenir la documentation utilisateur.

doc_read

effortless_doc_read — Stabilité : stable · projet

Lit un document de blueprints/ par chemin relatif à la racine du projet. Refuse tout chemin hors de blueprints/.

💬 Vous demandez à l’agent

« Lis le document blueprints/012-Epic-Export/cadrage.md. »

→ L’agent appelleeffortless_doc_read

• rel_path = blueprints/012-Epic-Export/cadrage.md

Nom	Type	Requis	Description
rel_path	string	oui	Chemin du document relatif à la racine du projet. Obligatoire.

docs_list

effortless_docs_list — Stabilité : stable · projet

Liste tous les documents Markdown de blueprints/ (récursif), avec leur titre. Lecture seule.

💬 Vous demandez à l’agent

« Liste les documents de blueprints/. »

→ L’agent appelleeffortless_docs_list

Aucun paramètre.

docs_search

effortless_docs_search — Stabilité : stable · projet

Recherche plein-texte (insensible à la casse et aux accents) dans les documents de blueprints/, triée par nombre d'occurrences, avec un extrait.

💬 Vous demandez à l’agent

« Cherche « authentification » dans les documents de blueprints/. »

→ L’agent appelleeffortless_docs_search

• query = authentification

Nom	Type	Requis	Description
query	string	oui	Terme de recherche plein texte. Obligatoire.

i18n_apply

effortless_i18n_apply

Écrit des traductions i18n dans l'override utilisateur (~/.effortless/locales/<surface>/<lang>.json) et marque les clés machine (ou human si reviewed=true). N'écrase jamais une entrée relue humaine sauf reviewed. Clés plates. Français interdit (source).

💬 Vous demandez à l’agent

« Applique ces traductions allemandes à l'interface : common.save devient « Speichern » et common.cancel devient « Abbrechen ». »

→ L’agent appelleeffortless_i18n_apply

• surface = front
• lang = de
• entries = {"common.save":"Speichern","common.cancel":"Abbrechen"}

Nom	Type	Requis	Description
surface	string	oui	Surface de traduction : front (interface utilisateur) ou mcp (descriptions d'outils). Obligatoire.
lang	string	oui	Code de la langue cible (en, es, ru, …) ; jamais fr, qui est la source. Obligatoire.
entries	object	oui	Traductions sous forme d'objet de clés plates vers texte (namespace.clé pour front, tools.<outil> pour mcp). Obligatoire.
reviewed	boolean	non	Si true, marque les entrées comme relues par un humain (protégées de l'écrasement) ; défaut false, elles sont marquées comme traductions machine.

i18n_export

effortless_i18n_export

Catalogue i18n fusionné (embarqué + override utilisateur) d'une surface et d'une langue, en JSON imbriqué.

💬 Vous demandez à l’agent

« Exporte le catalogue de traductions espagnol de l'interface. »

→ L’agent appelleeffortless_i18n_export

• surface = front
• lang = es

Nom	Type	Requis	Description
surface	string	oui	Surface de traduction : front (interface utilisateur) ou mcp (descriptions d'outils). Obligatoire.
lang	string	oui	Code de la langue cible (en, es, ru, …) ; fr est la source, son delta est donc vide. Obligatoire.

i18n_status

effortless_i18n_status

Delta de traduction i18n d'une surface (front|mcp) et d'une langue : clés absentes vs source FR (avec leur texte FR) et clés machine non relues. Base du flux de traduction assistée par l'Agent.

💬 Vous demandez à l’agent

« Quelles clés manquent dans la traduction allemande de l'interface ? »

→ L’agent appelleeffortless_i18n_status

• surface = front
• lang = de

Nom	Type	Requis	Description
surface	string	oui	Surface de traduction : front (interface utilisateur) ou mcp (descriptions d'outils). Obligatoire.
lang	string	oui	Code de la langue cible (en, es, ru, …) ; fr est la source, son delta est donc vide. Obligatoire.

project_docs_list

effortless_project_docs_list — Stabilité : stable · projet

Liste les documents de cadrage du projet : les fichiers à la racine de blueprints/ dont le frontmatter porte type: cadrage-projet. Lecture seule.

💬 Vous demandez à l’agent

« Liste les documents de cadrage du projet. »

→ L’agent appelleeffortless_project_docs_list

Aucun paramètre.

user_doc_coverage

effortless_user_doc_coverage — Stabilité : beta · projet

Documentation utilisateur : diagnostic de couverture (trou, page vieillie, page orpheline) et refus (inventaire invalide, mesure impossible, page altérée). Deux régimes : observation (par défaut) ou publication.

💬 Vous demandez à l’agent

« Fais le diagnostic de couverture de la documentation utilisateur du module site : trous, pages vieillies, pages orphelines. »

→ L’agent appelleeffortless_user_doc_coverage

• stack_id = site

Nom	Type	Requis	Description
stack_id	string	non	Id de la stack de documentation (défaut : la seule qui déclare une documentation utilisateur).
regime	string	non	Régime de couverture : observation (défaut) ou publication.

user_doc_inventory

effortless_user_doc_inventory — Stabilité : beta · projet

Documentation utilisateur : lit et valide l'inventaire déclaré, résout chaque source une seule fois. Refuse un inventaire invalide (code 5) ou une mesure impossible (code 6).

💬 Vous demandez à l’agent

« Valide l'inventaire de la documentation utilisateur du module site. »

→ L’agent appelleeffortless_user_doc_inventory

• stack_id = site

Nom	Type	Requis	Description
stack_id	string	non	Id de la stack de documentation (défaut : la seule qui déclare une documentation utilisateur).

user_doc_manifest

effortless_user_doc_manifest — Stabilité : beta · projet

Documentation utilisateur : clôt un build déjà produit. Interroge la paire de versions par la commande déclarée, écrit le manifeste en dernier dans output_dir, et retire la sortie entière s'il ne peut pas le produire.

💬 Vous demandez à l’agent

« Le build de la documentation du module site est fait dans dist/docs : clos-le en écrivant son manifeste. »

→ L’agent appelleeffortless_user_doc_manifest

• stack_id = site
• output_dir = dist/docs

Nom	Type	Requis	Description
stack_id	string	non	Id de la stack de documentation (défaut : la seule qui déclare une documentation utilisateur).
output_dir	string	oui	Répertoire de sortie du build, relatif à la racine de la stack ; il n'y a pas de défaut. Obligatoire.

user_doc_sync

effortless_user_doc_sync — Stabilité : beta · projet

Documentation utilisateur : installe une copie hors ligne dans l'ordre écrire, vérifier, mettre de côté, promouvoir, retirer. La candidate va dans staging_dir (emplacement distinct), son manifeste y est relu, et la version de format est interrogée auprès de la coque. Une copie de format différent est refusée et la copie existante est conservée ; une préproduction sur un autre support est refusée avant tout geste.

💬 Vous demandez à l’agent

« Installe la copie hors ligne de la documentation du module site : la candidate est dans dist/docs, la préproduction dans app/docs-staging, la copie courante dans app/docs. »

→ L’agent appelleeffortless_user_doc_sync

• stack_id = site
• source_dir = dist/docs
• staging_dir = app/docs-staging
• current_dir = app/docs

Nom	Type	Requis	Description
stack_id	string	non	Id de la stack de documentation (défaut : la seule qui déclare une documentation utilisateur).
source_dir	string	oui	Répertoire de la copie à installer, relatif à la racine de la stack. Obligatoire.
staging_dir	string	oui	Répertoire de préproduction, relatif à la racine de la stack ; il doit être distinct de la copie courante et sur le même support. Obligatoire.
current_dir	string	oui	Répertoire de la copie courante, celle que la coque sert, relatif à la racine de la stack. Obligatoire.