uv-research-project-docs

What problem does it solve?

This Skill helps maintain a consistent and evolving documentation structure for research projects, ensuring that analysis, features, implementation, and evaluation details stay synchronized with the project's lifecycle.

Core Features & Use Cases

• Scaffolds a standard set of documentation files: Includes analysis, features, implementation, progress, workloads, spec, and evaluation documents, along with dedicated directories for detailed feature, implementation, and evaluation notes.
• Ensures documentation stays synchronized: Provides guidelines and a script to update documentation whenever features change or implementation progresses.
• Use Case: When starting a new research project, use this Skill to initialize a docs/ directory with all necessary markdown files and subdirectories, providing a clear template for documenting the project's progress and design.

Quick Start

Run the scaffold script from this skill directory to initialize the documentation structure in your project's root directory.