documentation-search

Retrieve internal documentation using Retrieval-Augmented Generation across ADRs and runbooks.

392|73|Updated Jun 12, 2025
One-click install
npx skills add https://github.com/cnoe-io/ai-platform-engineering --skill documentation-search
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-search
Source: https://github.com/cnoe-io/ai-platform-engineering/tree/main/ui/src/skills/documentation-search
Command: npx skills add https://github.com/cnoe-io/ai-platform-engineering --skill documentation-search

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enables fast discovery of internal documentation and runbooks by using Retrieval-Augmented Generation to locate relevant knowledge across ADRs, runbooks, and Backstage TechDocs.

Core Features & Use Cases

  • RAG-based search across internal docs to surface runbooks, ADRs, and architecture docs
  • Source attribution to cite the exact doc that informed the answer
  • Guided retrieval flow for Phase 1-3 search plus answer synthesis
  • Use case: When a user needs deployment procedures or troubleshooting guides, the skill locates the most relevant documents and summarizes them.

Quick Start

Ask for internal documentation on a topic like 'deployment runbook' to retrieve the most relevant sources.

Frequently Asked Questions about documentation-search

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find internal documentation and runbooks using RAG?

RAG-based search locates internal documentation by retrieving relevant runbooks, ADRs, and architecture docs. It ranks results by relevance and provides source-attributed synthesized answers to quickly surface deployment procedures and troubleshooting guides.

What is source attribution in knowledge-base retrieval?

Source attribution in knowledge-base retrieval cites the exact internal document that informed the synthesized answer. This ensures transparency by pointing users to the original ADRs or runbooks for verification and deeper exploration of the topic.

Can I search across Backstage TechDocs and architecture docs for troubleshooting guides?

Yes, you can search across Backstage TechDocs and architecture docs for troubleshooting guides. The guided retrieval flow selects relevant internal sources, ranks them by relevance, and summarizes the content to help resolve operational issues.

What is the best way to locate ADRs and best practices across internal sources?

The best way to locate ADRs and best practices is using a guided retrieval flow that selects specific internal sources, ranks the documentation by relevance, and synthesizes answers with source attribution while highlighting gaps for further exploration.

Does documentation search work when internal knowledge has gaps or missing context?

Documentation search handles internal knowledge gaps by providing a clear path for further exploration. If relevant runbooks or architecture docs are missing, it synthesizes available information and explicitly indicates where documentation gaps exist.