Recherche dans la documentation du projet

VérifiéSûr

Trouvez des informations sur le projet dans le dossier docs/. Utilisez ceci pour obtenir le contexte sur l'état du projet, l'exécution des crawlers, les étapes de déploiement, les plans de recherche ou tout détail opérationnel.

Spar Skills Guide Bot
DocumentationDébutant
24/07/2026
Claude CodeCursorCodex
#docs-lookup#project-context#runbooks#onboarding#knowledge-base

Recommandé pour

Synthèse automatique

Cette skill indique à l'agent comment retrouver l'information utile dans le dossier docs/ d'un projet, en commençant par docs/README.md et docs/STATUS.md puis en ciblant le runbook ou la référence appropriée.

Points forts

  • Fournit une table de routage explicite entre besoins (crawler, déploiement, classification, droplet) et fichiers de documentation
  • Impose la lecture de STATUS.md comme source de vérité avant toute réponse, ce qui évite de s'appuyer sur des suppositions
  • Couvre aussi bien les runbooks opérationnels que la stratégie, les références d'architecture et les notes en cours
  • Prévoit de signaler honnêtement l'absence de réponse dans les docs plutôt que d'inventer

Limites

  • Entièrement lié à une arborescence docs/ précise (runbooks/, strategy/, references/, working/, archive/) : peu réutilisable telle quelle sur un autre projet
  • Ne décrit aucune procédure de mise à jour ou de création de documentation, seulement la consultation
  • La qualité du résultat dépend de la fraîcheur de STATUS.md et des fichiers référencés
Quand l'utiliser

À utiliser dès qu'un agent a besoin de contexte opérationnel ou stratégique sur ce projet avant d'agir, ou lorsque l'utilisateur demande de vérifier la documentation.

Quand l'éviter

À ne pas utiliser pour des questions générales sans rapport avec le projet ou lorsque l'information doit être obtenue en lisant directement le code source plutôt que la documentation.

Analyse de sécurité

Sûr
Score qualité92/100

The skill only instructs reading documentation files within a docs/ directory and summarizing information. It declares no tools, does not execute commands, access the network, or modify files. There is no destructive, exfiltrating, or obfuscated behavior.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Check project status
Check the docs and tell me the current corpus size, per-crawler doc counts, and whether production is in sync.
Deploy to production
I need to sync the latest data to production and deploy — look up the docs for the exact steps.
Build a new crawler
What do we know about building a new crawler? Check the docs before we start.

name: docs description: Find project information in the docs/ folder. Use when you need context about the project state, how to run crawlers, deployment steps, research plans, or any operational detail. Also use when the user says "check the docs", "look it up", "what do we know about X", or when you realize you're missing context to complete a task.

Project Documentation Lookup

Project documentation lives in docs/. Find what you need using this strategy.

Step 1: Orient

Read these two files first:

  1. docs/README.md — folder structure and quick links
  2. docs/STATUS.md — live project state: corpus size, per-crawler doc counts, droplet status, production sync state, classification progress

Read STATUS.md even if you think you know the answer — it's the source of truth.

Step 2: Find the right file

| You need to... | Read | |----------------|------| | Run a crawler, debug a crawl, understand a crawler's technique | docs/runbooks/crawling.md | | Build a new crawler from scratch | docs/runbooks/new-crawler-guide.md | | Sync data to production or deploy | docs/runbooks/sync-and-deploy.md | | Classify documents with DeepSeek | docs/runbooks/classification.md | | Set up or manage the droplet | docs/runbooks/droplet.md | | Know what to work on next (crawler expansion) | docs/strategy/crawl-expansion.md | | Understand the research vision, audience, competitive landscape | docs/strategy/research-vision.md | | Plan web app features | docs/strategy/website-features.md | | Understand the system architecture or database schema | docs/references/architecture.md | | Understand gkmlpt (Guangdong platform) | docs/references/gkmlpt-survey.md | | Understand how APIs and web scraping work | docs/references/apis-and-scraping.md | | Understand the AI policy governance chain (central to local) | docs/references/ai-policy-vertical.md | | Find in-progress research or notes | docs/working/ (list files) | | Find completed plans or historical session logs | docs/archive/ |

Step 3: Report

Summarize the key information found. If no docs file has the answer, say so.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/project-documentation-lookup-mryiqir1' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/project-documentation-lookup-mryiqir1/download' --output '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md.part' && mv '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md.part' '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md' && test -s '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs' && cp -R '.skill-downloads/project-documentation-lookup-mryiqir1' '.claude/skills/docs'

Cursor
test -f '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md' && test -s '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/docs' && cp -R '.skill-downloads/project-documentation-lookup-mryiqir1' '.cursor/skills/docs'

Codex
test -f '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md' && test -s '.skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/docs' && cp -R '.skill-downloads/project-documentation-lookup-mryiqir1' '.agents/skills/docs'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/project-documentation-lookup-mryiqir1'

openskills read 'project-documentation-lookup-mryiqir1'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/project-documentation-lookup-mryiqir1/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires