Does it support team collaboration?

Absolutely. Documents start in a personal namespace and can be promoted to a shared directory for team-wide review using the companion share-docs skill.

How does the skill handle file organization?

It uses a namespace system based on your Git username to store documents in 'thoughts/{namespace}/', ensuring personal research stays organized before being shared.

Can I reference specific lines of code in the research doc?

Yes, the skill is specifically designed to include 'file:line' references to ensure research findings are tied directly to the relevant source code.

What kind of metadata is automatically collected?

The skill automatically gathers the current timestamp, Git commit hash, branch name, and repository name to provide full context for the research.

Research Document Writer

Name: Research Document Writer
Author: eveld

byeveld

•

학습 및 문서화

Generates structured, professional research documents with automated metadata and precise code-level references.

The write-research-doc skill streamlines the process of documenting technical investigations and architectural explorations directly within your repository. It enforces a standardized Markdown template featuring YAML frontmatter, Git metadata, and organized sections for research questions and implementation patterns. By utilizing a namespace-based directory structure (thoughts/{user}/{id}-description), it allows developers to maintain personal research logs that can be easily promoted to shared team documentation, ensuring that critical technical knowledge is preserved, searchable, and grounded in specific code references.

주요 기능

01Intelligent directory management with personal and shared namespaces

02Standardized templates for research questions, summaries, and findings

03Precise code referencing using file and line-number pointers

04Automated YAML frontmatter generation with Git and timestamp metadata

05Integration with feature slug detection for consistent naming conventions

063 GitHub stars

사용 사례

01Creating a permanent record of codebase exploration for onboarding

02Documenting technical 'Spikes' or architectural feasibility studies

03Building a shared knowledge base of implementation patterns and discoveries

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add eveld/claude write-research-doc

For use in Claude.ai and ChatGPT

Download Skill