scientific-documentation

Bbeierle12 的头像作者 Bbeierle12

为完成的编码项目生成全面的科学研究风格文档。当用户请求项目文档、技术分析、研究论文、讲座文档或想要了解他们刚刚构建的项目的所有内容时使用。触发短语包括"记录这个项目"、"创建研究论文"、"解释我们所做的一切"、"编写完整分析"、"科学文档"或"我想从这个项目学习"。产生具有学术结构、初学者友好解释和详尽代码分析的正式Word文档(.docx)。

📖 中文导读:为完成的编码项目生成全面的科学研究风格文档。当用户请求项目文档、技术分析、研究论文、讲座文档或想要了解他们刚刚构建的项目的所有内容时使用。触发短语包括"记录这个项目"、"创建研究论文"、"解释我们所做的一切"、"编写完整分析"、"科学文档"或"我想从这个项目学习"。产生具有学术结构、初学者友好解释和详尽代码分析的正式Word文档(.docx)。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: scientific-documentation description: 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.

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