Skip to main content
NEW · APP STORE Now on iOS · macOS · iPad Android & Windows soon GET IT
Prompts Codebase Wiki Question Answering

agent analysis skill risk: low

Codebase Wiki Question Answering

Answer repository questions grounded entirely in source code evidence by searching files, reading content, and synthesizing responses with inline citations and a Key Files table.

  • External action: medium

SKILL 1 file

SKILL.md
---
name: wiki-qa
description: "Answer repository questions grounded entirely in source code evidence. Use when user asks a question about the codebase, user wants to understand a specific file, function, or component, or user asks /\"how does X work/\" or /\"where is Y defined/\"."
---
# Wiki Q&A

Answer repository questions grounded entirely in source code evidence.

## When to Use
- User asks a question about the codebase
- User wants to understand a specific file, function, or component
- User asks "how does X work" or "where is Y defined"

## Procedure

1. Detect the language of the question; respond in the same language
2. Search the codebase for relevant files
3. Read those files to gather evidence
4. Synthesize an answer with inline citations

## Response Format

- Use `##` headings, code blocks with language tags, tables, bullet lists
- Cite sources inline: `(src/path/file.ts:42)`
- Include a "Key Files" table mapping files to their roles
- If information is insufficient, say so and suggest files to examine

## Rules

- ONLY use information from actual source files
- NEVER invent, guess, or use external knowledge
- Think step by step before answering

### When to Use
This skill is applicable to execute the workflow or actions described in the overview.

## Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

REQUIRED CONTEXT

  • user question about the codebase

ROLES & RULES

  1. ONLY use information from actual source files
  2. NEVER invent, guess, or use external knowledge
  3. Think step by step before answering

EXPECTED OUTPUT

Format
markdown
Schema
markdown_sections · ## headings, code blocks with language tags, tables, bullet lists, Key Files table, inline citations (src/path/file.ts:42)
Constraints
  • Use ## headings, code blocks with language tags, tables, bullet lists
  • Cite sources inline as (src/path/file.ts:42)
  • Include a Key Files table mapping files to their roles
  • If information is insufficient, say so and suggest files to examine
  • ONLY use information from actual source files
  • NEVER invent, guess, or use external knowledge

SUCCESS CRITERIA

  • Detect the language of the question; respond in the same language
  • Search the codebase for relevant files
  • Read those files to gather evidence
  • Synthesize an answer with inline citations
  • Include a Key Files table mapping files to their roles
  • If information is insufficient, say so and suggest files to examine

FAILURE MODES

  • May invent or guess information not present in source files
  • May omit required Key Files table or inline citations
  • May respond in wrong language

CAVEATS

Missing context
  • Method or tooling for performing the 'Search the codebase' step
  • Definition of required inputs, permissions, or safety boundaries mentioned in Limitations
Ambiguities
  • Duplicate 'When to Use' section with conflicting content and scope.
  • 'This skill is applicable to execute the workflow or actions described in the overview.' references a non-existent overview.

QUALITY

OVERALL
0.71
CLARITY
0.78
SPECIFICITY
0.68
REUSABILITY
0.72
COMPLETENESS
0.65

IMPROVEMENT SUGGESTIONS

  • Remove the redundant second 'When to Use' section and integrate its intent into the first section or Limitations.
  • Replace the generic 'Search the codebase' step with concrete instructions or tool calls for retrieval.

USAGE

Copy the prompt above and paste it into your AI of choice — Claude, ChatGPT, Gemini, or anywhere else you're working. Replace any placeholder sections with your own context, then ask for the output.

MORE FOR AGENT