de rails-agent-skills17
Générez un contenu clair et copiable pour les README et les guides de moteurs Rails : installation, montage, configuration, exemples d'utilisation et notes de migration.
Document Engine aide les auteurs à produire une documentation pratique et prête pour l'application hôte pour les moteurs Ruby on Rails. Il génère des modèles de README et des sections de guide axés sur le chemin d'installation minimal viable, des instructions de montage explicites, des options de configuration avec valeurs par défaut, des exemples d'utilisation avec du code copiable, ainsi que des notes de migration et d'exploitation. La compétence impose une liste de contrôle « hard-gate » pour s'assurer que chaque résultat documente les étapes et les hypothèses requises pour l'application hôte (modèles, backends de jobs, authentification).
Utilisez cette compétence lorsque vous devez créer ou améliorer la documentation d'un moteur Rails avant sa publication ou lors de l'intégration d'un moteur dans une application hôte. Déclenchez-la lors de la rédaction du README, des guides d'installation, de la référence de configuration, des documents d'intégration pour les intégrateurs et des journaux de modifications affectant la configuration. Elle est particulièrement utile lorsque vous devez garantir que la documentation inclut des instructions de fonctionnement minimales et des exemples explicites de montage et de configuration.
Fonctionne comme une compétence de rédaction en langage naturel pour les assistants conscients du code et les agents capables d'utiliser le CLI qui peuvent éditer du markdown (assistants de type Copilot/Codex/Gemini). Les résultats sont en markdown simple, destinés aux mainteneurs humains et aux vérifications de documentation via CI.
Cette compétence n'a pas encore été examinée par notre pipeline d'audit automatisé.
