Flux de travail axé sur les spécifications
Définissez les exigences avant d'écrire le code.
OpenSpecDéveloppement piloté par les spécifications pour les assistants IA
Une spécification légère pour créer et gérer des projets d'assistants IA.
Bienvenue. C'est le point central pour tout ce qui concerne OpenSpec.
OpenSpec vous aide, vous et votre assistant de codage IA, à vous mettre d'accord sur ce qu'il faut construire avant d'écrire le moindre code. Vous décrivez le changement, l'IA rédige une brève spécification et une liste de tâches, vous examinez tous les deux le même plan, puis le travail commence. Plus besoin de découvrir à mi-chemin que l'IA a construit la mauvaise chose.
Si vous ne devez lire que deux pages, lisez celles-ci :
/opsx:propose (indice : dans votre chat IA, pas dans le terminal). Presque tout le monde trébuche dessus au moins une fois.Cette deuxième page est plus importante qu'il n'y paraît. OpenSpec se compose de deux parties : un outil en ligne de commande que vous exécutez dans votre terminal, et des commandes slash que vous donnez à votre assistant IA. Savoir lequel est lequel vous évite la confusion la plus courante.
La meilleure habitude à prendre en premier : quand vous n'êtes pas sûr de ce que vous devez construire, commencez par
/opsx:explore. C'est un partenaire de réflexion sans enjeu qui lit votre code, évalue les options et transforme une idée floue en un plan concret avant même qu'un artéfact ou du code n'existe. Le guide Explorer d'abord en fait la démonstration.
Je suis tout nouveau. Commencez par Premiers pas, puis parcourez Aperçu des concepts fondamentaux. Quand quelque chose vous semble mystérieux, la FAQ et le Glossaire sont à portée de main.
J'ai un problème, mais pas de plan. C'est le cas le plus courant, et il a une réponse dédiée : Explorer d'abord. Utilisez /opsx:explore pour y réfléchir avec l'IA avant de vous engager sur quoi que ce soit.
J'ai une base de code existante volumineuse. Vous ne documentez pas tout. Utiliser OpenSpec dans un projet existant montre comment démarrer sur du code réel, existant, sans vouloir tout refaire d'un coup.
Je veux juste que ça fonctionne. Installez, exécutez openspec init, puis lisez Comment fonctionnent les commandes pour que votre première commande slash atterrisse au bon endroit. Ou confiez la configuration à votre assistant avec l'invite d'installation assistée par IA.
J'apprends par l'exemple. La page Exemples & Recettes parcourt des changements réels du début à la fin : une petite fonctionnalité, une correction de bug, une refactorisation, une exploration.
L'IA vient de rédiger un plan — et maintenant ? Lisez-le. Revoir un changement montre la vérification de deux minutes qui permet de repérer une erreur alors qu'il est encore temps de corriger à peu de frais, et Bien rédiger des spécifications explique ce qui constitue un plan digne d'approbation.
Je travaille en équipe. OpenSpec en équipe montre comment un changement se traduit par une branche et une demande de tirage (pull request), et comment les coéquipiers examinent un plan avant le code.
Je viens de l'ancien flux de travail. Le Guide de migration explique ce qui a changé et pourquoi, et garantit que votre travail existant est en sécurité.
Je veux l'adapter au processus de mon équipe. La Personnalisation couvre la configuration du projet, les schémas personnalisés et le contexte partagé.
Quelque chose ne fonctionne pas. Le Dépannage rassemble les échecs que les gens rencontrent réellement, avec des solutions.
| Doc | Ce qu'il vous apporte |
|---|---|
| Premiers pas | Installez, initialisez et exécutez votre premier changement de bout en bout |
| Explorer d'abord | Utilisez /opsx:explore pour réfléchir à une idée avant de vous engager |
| Comment fonctionnent les commandes | Où les commandes slash s'exécutent, ce que signifie "mode interactif", terminal vs chat |
| Aperçu des concepts fondamentaux | Tout le modèle mental sur une page : spécifications, changements, deltas, archive |
| Installation | npm, pnpm, yarn, bun, Nix, une invite qui confie la configuration à votre assistant IA, et comment vérifier que cela a fonctionné |
| Doc | Ce qu'il vous apporte |
|---|---|
| Flux de travail | Modèles courants et quand utiliser chaque commande |
| Exemples & Recettes | Parcours complets de vrais changements, prêts à être copiés-collés |
| Bien rédiger des spécifications | À quoi ressemblent une exigence solide et un scénario, et comment dimensionner correctement un changement |
| Revoir un changement | La vérification de deux minutes d'un plan rédigé avant l'écriture du code |
| OpenSpec en équipe | Comment les changements s'intègrent aux branches, aux demandes de tirage et à la revue |
| Utiliser OpenSpec dans un projet existant | Adopter OpenSpec sur une grande base de code existante |
| Édition & Itération d'un changement | Mettre à jour les artéfacts, revenir en arrière, réconcilier les modifications manuelles |
| Commandes | Référence pour chaque commande slash /opsx:* |
| CLI | Référence pour chaque commande du terminal openspec |
| Doc | Ce qu'il vous apporte |
|---|---|
| Concepts | L'explication détaillée des spécifications, des changements, des artéfacts, des schémas et de l'archive |
| Flux de travail OPSX | Pourquoi le flux de travail est fluide plutôt que verrouillé par phases, avec une plongée approfondie dans l'architecture |
| Glossaire | Tous les termes définis en un seul endroit |
| Doc | Ce qu'il vous apporte |
|---|---|
| Personnalisation | Configuration du projet, schémas personnalisés, contexte partagé |
| Multilingue | Générez des artéfacts dans d'autres langues que l'anglais |
| Outils supportés | Les plus de 30 outils d'IA avec lesquels OpenSpec s'intègre, et où les fichiers sont stockés |
| Vitrine de la communauté | Projets et ressources construits avec et pour OpenSpec |
| Doc | Ce qu'il vous apporte |
|---|---|
| FAQ | Réponses rapides aux questions les plus fréquentes |
| Dépannage | Correctifs concrets pour des échecs concrets |
| Guide de migration | Passer de l'ancien flux de travail à OPSX |
| Doc | Ce qu'il vous apporte |
|---|---|
| Stores : Guide utilisateur | Planifiez dans son propre dépôt lorsque votre travail couvre plusieurs dépôts ou équipes |
| Contrat d'agent | L'interface en ligne de commande lisible par machine que les agents exploitent |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← optional, but a great habit
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archiveLes étapes 1 et 2 se déroulent dans votre terminal. Le reste se passe dans le chat de votre assistant IA. Cette distinction est la seule chose qui mérite d'être mémorisée, et Comment fonctionnent les commandes explique exactement pourquoi. L'étape 3 est facultative, mais commencer avec /opsx:explore quand vous n'êtes pas sûr est l'habitude qui vaut le plus la peine d'être prise.
openspec feedback "votre message" envoie un commentaire directement depuis votre terminal (cela ouvre un ticket GitHub).Vous avez trouvé quelque chose d'erroné, d'obsolète ou de déroutant dans cette documentation ? C'est un bug. Ouvrez un ticket ou une PR. Les améliorations de la documentation font partie des contributions les plus précieuses que vous puissiez apporter.