read-docs

Read project documentation from ./docs and log access with helpfulness scores.

1|Updated Jun 4, 2025
One-click install
npx skills add https://github.com/df07/go-progressive-raytracer --skill read-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: read-docs
Source: https://github.com/df07/go-progressive-raytracer/tree/main/.claude/skills/read-docs
Command: npx skills add https://github.com/df07/go-progressive-raytracer --skill read-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Read project documentation from ./docs with access logging to surface helpful topics and ensure usage transparency.

Core Features & Use Cases

  • Reads and surfaces relevant documentation from the ./docs folder to aid understanding of architecture, design decisions, and component interactions.
  • Logs each doc access with a usefulness score to identify valuable resources and gaps in coverage.
  • Automatically creates and appends documentation-requests when docs are missing, outdated, or insufficient to answer user questions.

Quick Start

Ask me to read a documentation file from ./docs and I will open it and log your feedback.

Frequently Asked Questions about read-docs

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

FAQPage Schema
How do I read project documentation and track which files are actually useful?▼

Reading project documentation with access logging records each file you open alongside a helpfulness score, tracking usage transparency and surfacing valuable resources. This approach logs interactions via a helper script with UTC timestamps to guide documentation quality improvements.

What is the best way to find missing or outdated docs in a project?▼

Finding missing or outdated docs involves checking the ./docs folder and automatically appending documentation requests to a tracking file. When existing files are insufficient to answer questions, a request entry is created in ./docs/documentation-requests.md with a UTC timestamp to track coverage gaps.

Can I log documentation access without modifying my existing project files?▼

Logging documentation access uses an atomic append workflow via a helper script, safely recording interactions without altering your original project files. This method adds entries to a dedicated log and appends new requests to ./docs/documentation-requests.md, keeping source documents untouched.

How do I request new documentation when existing files do not cover my architecture questions?▼

Requesting new documentation happens automatically when current files fail to answer architecture or component questions. The workflow appends a new entry to ./docs/documentation-requests.md with a UTC timestamp, creating a transparent record of needed updates for your team.

Does this documentation workflow require any external dependencies?▼

This documentation workflow requires no external dependencies to read files and log access. It operates entirely within your project environment using a helper script to manage the atomic append process and record helpfulness scores with UTC timestamps.