scientific-documentation

Included with Lifetime

$97 forever

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.

Writing & Docs

What this skill does

# 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

1. **Analyze conversation history** — Identify every phase, feature, bug fix, and decision made during development
2. **Read the document template** — Load `references/document-template.md` for the complete structure specification
3. **Read the docx skill** — Load `/mnt/skills/public/docx/SKILL.md` and its `docx-js.md` reference for Word document creation
4. **Generate the document** — Create a comprehensive .docx file following the template structure
5. **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*

Files: 3

Size: 9.7 KB

Complexity: 29/100

Category: Writing & Docs

Source: https://github.com/bbeierle12/skill-mcp-claude/tree/main/skills/scientific-documentation

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts