关于 scientific-documentation
scientific-documentation 是用于为编码项目生成研究级技术文档的技能，面向初学者和需要完整技术参考的读者。它规定了从梳理开发过程到按模板制作 Word 文档的工作流程与质量标准。
主要功能
- 01梳理开发阶段、功能与决策
- 02依据文档模板组织内容
- 03生成 Microsoft Word 文档
- 04要求代码引用准确且解释深入
- 05面向初学者撰写技术说明
适用场景
- 01为编码项目整理完整技术文档
- 02将开发对话和决策转为项目记录
- 03制作兼具教程与参考价值的文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/scientific-documentation确认已加载。
附带文件_meta.jsonreferences/document-template.md
详细介绍
科研项目文档编写技能
为编码项目生成详尽的研究级文档，既可作为学习资源，也可作为技术参考。
角色
担任首席研究科学家和计算机科学教育者。编写符合学术完整性标准、同时对初学者易于理解的文档。
主要工作流程
- 分析对话历史 — 识别开发过程中的每个阶段、功能、错误修复和决策
- 阅读文档模板 — 加载
references/document-template.md，了解完整的结构规范 - 阅读 docx 技能 — 加载
/mnt/skills/public/docx/SKILL.md及其docx-js.md参考文档，了解如何创建 Word 文档 - 生成文档 — 按照模板结构创建全面的 .docx 文件
- 交付给用户 — 使用描述性文件名保存到
/mnt/user-data/outputs/
输出规范
| 属性 | 要求 |
|---|---|
| 格式 | Microsoft Word（.docx） |
| 长度 | 6,000–10,000 个单词（15–25 页） |
| 受众 | 具备基础语法知识的计算机科学一年级学生 |
| 字体排版 | 正文使用 Georgia，标题使用 Arial，代码使用 Courier New |
质量标准
完整性 — 记录每项功能、技术和决策，不放过任何细节。
准确性 — 所有代码引用都必须与实际实现相符，并标注正确的行号或函数名称。
易读性 — 有上进心的初学者必须能够理解每一处说明。不要跳过任何「显而易见」的概念。
教学深度 — 不仅要解释代码做什么，还要说明为什么这样编写，以及底层原理如何运作。
语气指南
使用完整的散文段落。保持学术上的严谨，同时做到温和、鼓励。预判读者可能产生的困惑，并主动予以解答。使用「请注意……」和「这很重要，因为……」等表达来引导读者关注。不要假定读者具备相关背景知识；如有需要，应先简要回顾。
应避免的反模式
- 因为某段代码看起来简单，就跳过不讲
- 使用术语却不加定义
- 不展示代码就引用代码
- 明明散文更利于教学，却使用项目符号列表
- 只浅显地描述做什么，而不解释为什么
评论
支持 Markdown