Agent skill
scientific-documentation
Generate comprehensive scientific research-style documentation for completed coding projects. Use when the user requests project documentation, a technical breakdown, a study paper, a lecture document, or wants to understand everything about a project they just built. Triggers include phrases like "document this project," "create a study paper," "explain everything we did," "write up the full breakdown," "scientific documentation," or "I want to learn from this project." Produces formal Word documents (.docx) with academic structure, beginner-friendly explanations, and exhaustive code analysis.
Install this agent skill to your Project
npx add-skill https://github.com/Bbeierle12/Skill-MCP-Claude/tree/main/skills/scientific-documentation
SKILL.md
Scientific Project Documentation Skill
Generate exhaustive, research-grade documentation for coding projects that serves both as a learning resource and technical reference.
Role
Act as a Principal Research Scientist and Computer Science Educator. Prepare documentation that meets academic standards for completeness while remaining accessible to beginners.
Primary Workflow
- Analyze conversation history — Identify every phase, feature, bug fix, and decision made during development
- Read the document template — Load
references/document-template.mdfor the complete structure specification - Read the docx skill — Load
/mnt/skills/public/docx/SKILL.mdand itsdocx-js.mdreference for Word document creation - Generate the document — Create a comprehensive .docx file following the template structure
- Deliver to user — Save to
/mnt/user-data/outputs/with a descriptive filename
Output Specifications
| Attribute | Requirement |
|---|---|
| Format | Microsoft Word (.docx) |
| Length | 6,000–10,000 words (15-25 pages) |
| Audience | First-year CS student with basic syntax knowledge |
| Typography | Georgia body, Arial headings, Courier New for code |
Quality Standards
Completeness — Document every feature, technique, and decision. Leave no stone unturned.
Accuracy — All code references must match the actual implementation with correct line numbers or function names.
Accessibility — A motivated beginner must be able to follow every explanation. Never skip "obvious" concepts.
Pedagogical Depth — Explain not just what code does, but why it was written that way and how the underlying principles work.
Tone Guidelines
Write in complete prose paragraphs. Maintain academic formality while remaining warm and encouraging. Anticipate confusion and address it proactively. Use phrases like "Notice that..." and "This is important because..." to guide attention. Never assume prior knowledge without briefly reviewing it.
Anti-Patterns to Avoid
- Skipping "simple" code because it seems obvious
- Using jargon without definition
- Referencing code without showing it
- Bullet-point lists where prose would teach better
- Shallow explanations that describe what without why
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
r3f-materials
Three.js materials in R3F, built-in materials (Standard, Physical, Basic, etc.), ShaderMaterial with custom GLSL, uniforms binding and animation, and material properties. Use when choosing materials, creating custom shaders, or binding dynamic uniforms.
audio-router
Router for audio domain including playback, analysis, and audio-reactive visuals. Use when implementing any audio functionality including music, sound effects, visualizers, or audio-driven animations. Routes to 3 specialized skills.
case-studies-reference
Game building mechanics case studies and decision frameworks. Use when designing building systems, evaluating trade-offs, or learning from existing games. Reference-only skill with detailed analysis of Fortnite, Rust, Valheim, Minecraft, No Man's Sky, and Satisfactory building systems.
brainstorming
Use when starting any feature, project, or design work. Guides collaborative design refinement through incremental questioning before any code is written.
shader-router
Decision framework for GLSL shader projects. Routes to specialized shader skills (fundamentals, noise, SDF, effects) based on task requirements. Use when starting a shader project or needing guidance on which shader techniques to combine.
audio-playback
Audio playback using Tone.js including players, transport, scheduling, and loading audio. Use when implementing background music, sound effects, audio synchronization, or timed audio events. Essential for any audio-enabled web application.
Didn't find tool you were looking for?