بنقرة واحدة
doc-search
Search project documentation — ADRs, wiki entries, conventions via ripgrep, qmd, fff, and ctx
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Search project documentation — ADRs, wiki entries, conventions via ripgrep, qmd, fff, and ctx
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Verify understanding after implementation with targeted quizzes
Clarify requirements through targeted questions — uncovers unknown unknowns in specs
Remove AI-generated code patterns that don't match codebase style
Review code for quality, security, and best practices — read-only analysis
Create clear documentation for code and APIs
Audit code for security vulnerabilities — read-only analysis
| name | doc-search |
| description | Search project documentation — ADRs, wiki entries, conventions via ripgrep, qmd, fff, and ctx |
| license | MIT |
| compatibility | cline, claude, opencode, amp, codex, gemini, cursor, pi |
| hint | Use when you need to find existing documentation before writing new docs |
| user-invocable | true |
Use this skill when:
Helps you find and navigate existing project documentation using available tools (grep, qmd, fff, ctx). Documentation is often scattered across multiple locations — this skill provides a systematic approach to find what you need.
This project stores documentation in several locations:
| Location | Content | Best For |
|---|---|---|
docs/ | User-facing guides (quick-start, tutorials) | Getting started, feature guides |
ADRs via configs/adr/* | Architecture Decision Records | Why decisions were made |
wiki/ | LLM wiki — entities, concepts, log | Knowledge base, cross-references |
MEMORY.md | Durable project learnings and gotchas | Known issues, conventions |
skills/*/SKILL.md | Agent skill definitions | Tool capabilities |
configs/*.md | Tool-specific documentation | Per-tool behavior |
AGENTS.md | Agent instructions and guidelines | Development workflow |
| qmd knowledge base | Indexed project knowledge | Searchable, AI-powered retrieval |
Use fff to locate documentation files:
fff "*.md" docs/ # All documentation files
fff "*adr*" # Architecture Decision Records
fff "*auth*" docs/ # Auth-related documentation
fff "*wiki*" # Wiki entries
Use rg (ripgrep) to search documentation content:
rg "decision" docs/ # Find decisions in docs
rg "ADR-0" . --glob "*.md" # Find ADR references
rg "rate.limiting" --glob "*.md" # Find docs about rate limiting
Use qmd to search durable project knowledge:
qmd search "authentication decisions" # Find related knowledge
qmd query "What architecture exists for X?" # Get structured answers
qmd get ADR-001 # Get a specific ADR
The qmd knowledge base indexes project learnings, ADRs, conventions, and gotchas that persist across agent sessions.
Use ctx to find previous discussions about documentation:
ctx search "documentation" "decision" # Past doc discussions
ctx search "ADR" "architecture" path/docs/ # Past ADR discussions
ctx search "convention" "pattern" # Past convention discussions
Project documentation follows consistent patterns:
Architecture Decision Records (ADRs):
# Find all ADRs
ls -la docs/adr/
# Search ADR content
rg "decision" docs/adr/
Wiki entries:
# Browse wiki structure
ls -la wiki/wiki/entities/
ls -la wiki/wiki/concepts/
# Search wiki content
rg "topic" wiki/wiki/ --glob "*.md"
Agent skills:
# Find skill documentation
rg "what.*does" skills/*/SKILL.md
# Find skills by category
rg "compatibility:.*auth" skills/*/SKILL.md
Before writing new documentation, study existing examples:
Example: If you need to write an ADR, read an existing ADR first:
fff "*adr*.md" # Find existing ADRs
cat docs/adr/001-some-decision.md # Read as reference
Before writing:
1. Search existing docs for related content
2. Check qmd for existing knowledge
3. Search ctx for past discussions
4. Read existing docs for style reference
During writing:
5. Link to relevant ADRs and decisions
6. Reference existing conventions
7. Cross-link related documentation
After writing:
8. Add to wiki or qmd knowledge base
9. Reference from relevant agent instructions
10. Update docs-update skill if patterns changed
rg over grep: ripgrep is faster and respects .gitignore