scientific-documentation
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseScientific 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 for the complete structure specification
references/document-template.md - Read the docx skill — Load and its
/mnt/skills/public/docx/SKILL.mdreference for Word document creationdocx-js.md - Generate the document — Create a comprehensive .docx file following the template structure
- Deliver to user — Save to with a descriptive filename
/mnt/user-data/outputs/
- 分析对话历史 —— 识别开发过程中的每个阶段、功能、漏洞修复与决策
- 读取文档模板 —— 加载以获取完整的结构规范
references/document-template.md - 读取Docx技能文档 —— 加载及其
/mnt/skills/public/docx/SKILL.md参考文档，用于Word文档创建docx-js.md - 生成文档 —— 遵循模板结构创建全面的.docx文件
- 交付给用户 —— 保存至目录，并使用描述性文件名
/mnt/user-data/outputs/
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 |
| 属性 | 要求 |
|---|---|
| 格式 | Microsoft Word（.docx） |
| 篇幅 | 6000–10000字（15-25页） |
| 受众 | 具备基础语法知识的计算机科学专业一年级学生 |
| 排版 | 正文使用Georgia字体，标题使用Arial字体，代码使用Courier New字体 |
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
- 因看似简单而跳过对“基础”代码的说明
- 使用术语却不给出定义
- 提及代码却不展示具体内容
- 在适合用散文教学的场景使用 bullet 点列表
- 只描述是什么却不解释为什么的浅层说明