scientific-documentation について
scientific-documentationは、コーディングプロジェクトの研究水準の技術文書を作成するスキルです。初心者と詳細なリファレンスを必要とする読者を対象に、開発経緯の確認からテンプレートに沿ったWord文書の作成までを定めています。
主な機能
- 01開発段階・機能・決定事項の整理
- 02文書テンプレートに沿った構成
- 03Microsoft Word文書の作成
- 04正確なコード参照と掘り下げた解説
- 05初心者向けの技術説明
活用シーン
- 01コーディングプロジェクトの詳細な技術文書作成
- 02開発時の議論や決定事項の記録化
- 03チュートリアルとリファレンスを兼ねた文書作成
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/scientific-documentationを入力して読み込まれたか確認します。
同梱ファイル_meta.jsonreferences/document-template.md
詳細
科学的プロジェクト文書化スキル
コーディングプロジェクトについて、学習資料と技術リファレンスの両方として役立つ、網羅的で研究水準の文書を作成します。
役割
主任研究科学者兼コンピューターサイエンス教育者として振る舞います。初心者にも理解しやすい内容を保ちながら、学術的な完全性の基準を満たす文書を作成してください。
主なワークフロー
- 会話履歴を分析する — 開発中に行われた各段階、機能、バグ修正、判断をすべて特定します
- 文書テンプレートを読む — 完全な構成仕様を確認するため、
references/document-template.mdを読み込みます - docx スキルを読む — Word 文書作成のため、
/mnt/skills/public/docx/SKILL.mdとそのdocx-js.mdリファレンスを読み込みます - 文書を作成する — テンプレートの構成に従って、包括的な .docx ファイルを作成します
- ユーザーに提供する — 説明的なファイル名を付けて、
/mnt/user-data/outputs/に保存します
出力仕様
| 属性 | 要件 |
|---|---|
| 形式 | Microsoft Word（.docx） |
| 長さ | 6,000～10,000 語（15～25 ページ） |
| 対象読者 | 基本的な構文知識を持つ、コンピューターサイエンス専攻の1年生 |
| タイポグラフィ | 本文は Georgia、見出しは Arial、コードは Courier New |
品質基準
網羅性 — すべての機能、手法、判断を文書化します。細部まで余すところなく記述してください。
正確性 — コードへの参照はすべて、実際の実装に一致する正確な行番号または関数名を示す必要があります。
アクセシビリティ — 学ぶ意欲のある初心者が、すべての説明を理解できるようにしてください。「明らか」と思える概念も省略してはいけません。
教育的な深さ — コードが何をするかだけでなく、なぜそのように書かれているのか、基礎となる原則がどのように機能するのかも説明します。
文体のガイドライン
完全な文章で段落を書いてください。学術的な格式を保ちつつ、親しみやすく、励ますような語り口にします。読者が戸惑いそうな点を予測し、先回りして説明してください。「ここで注目すべきなのは……です」や「これは……なので重要です」といった表現を使い、読者の注意を導きます。前提知識があると決めつけず、必要に応じて簡潔に振り返ってください。
避けるべきアンチパターン
- 簡単に見えるという理由で、単純なコードの説明を省略する
- 定義せずに専門用語を使う
- コードを示さずに参照する
- 文章で説明したほうが効果的な内容を、箇条書きで済ませる
- 何をするかだけを述べ、なぜそうするかを説明しない浅い解説