About scientific-documentation
scientific-documentation is a skill for producing research-grade technical documentation for coding projects, aimed at beginners and readers who need a thorough reference. It defines a workflow from reviewing development history to creating a Word document from a template, with explicit quality standards.
Key features
- 01Reviews development phases, features, and decisions
- 02Structures content using a document template
- 03Creates Microsoft Word documents
- 04Requires accurate code references and deep explanations
- 05Writes technical material for beginners
Use cases
- 01Create complete technical documentation for a coding project
- 02Turn development discussions and decisions into project records
- 03Produce documents that serve as tutorials and references
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/scientific-documentationin Claude Code to confirm it loaded.
Bundled files_meta.jsonreferences/document-template.md
Details
From the project READMEScientific 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