documentation-research

Fetch and cite current upstream documentation for external dependencies.

2|Updated Jul 13, 2025

Search Tags:#codebase analysis #research automation #dependency documentation #external API research #SDK documentation

Ready to run

npx skills add https://github.com/krzemienski/shannon --skill documentation-research-krzemienski

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-research
Source: https://github.com/krzemienski/shannon/tree/main/skills/documentation-research
Command: npx skills add https://github.com/krzemienski/shannon --skill documentation-research-krzemienski

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of fetching and citing current upstream documentation for every external dependency in scope, ensuring that every external fact is grounded in fetched documentation.

Core Features & Use Cases

Fetches Documentation: Automatically fetches documentation for external dependencies.
Cites Sources: Cites 3-5 verified facts per source with inline citations.
Use Case: Before writing code against an external SDK/framework/API/CLI, during forge Phase 2, or whenever training data may be stale.

Quick Start

Run the documentation-research skill to fetch and cite documentation for your external dependencies.

Frequently Asked Questions about documentation-research

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

FAQPage Schema

How do I fetch and cite current upstream documentation for external dependencies?▼

To fetch and cite upstream documentation for external dependencies, run the documentation-research process during forge Phase 2 or before SDK/API integration. It automatically gathers current external facts and ensures they are grounded in fetched documentation with inline citations.

When should I research external API documentation before integration?▼

Research external API documentation before writing code against an external SDK, framework, or CLI, or whenever training data may be stale. Running this during forge Phase 2 ensures all external dependency facts are verified and cited before integration.

How does automated dependency documentation research handle source citations?▼

Automated dependency documentation research handles source citations by citing three to five verified facts per fetched source. It uses inline citations and generates ISO-8601 timestamped source files alongside a SUMMARY.md file to track all external facts.

What is the best way to ensure external SDK documentation facts are not stale?▼

The best way to ensure external SDK documentation facts are not stale is to fetch current upstream documentation directly. This process grounds all external facts in fetched sources with ISO-8601 timestamps, verifying accuracy before you write integration code.

Can I use automated research to document external SDKs before writing integration code?▼

Yes, you can use automated research to document external SDKs before writing integration code. It fetches current upstream documentation, verifies three to five facts per source with inline citations, and outputs a SUMMARY.md file to ground your code in accurate external facts.

What limitations should I expect when automating external dependency documentation research?▼

When automating external dependency documentation research, expect that it focuses strictly on fetching and citing external facts for dependencies in scope. It does not replace internal codebase analysis and relies on upstream documentation being accessible to generate its ISO-8601 timestamped source files.