Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 10878] ファイルの概要

このコミットは、Go言語の公式ドキュメントから古いGoコースのノート（PDFファイル）を削除し、それらへの参照を更新するものです。これは、これらの資料が古くなっており、メンテナンスが困難であること、そして「Go Tour」というより優れたインタラクティブな学習リソースが存在するためです。

コミット

commit c99f4f5bf648217987859d8afa0bd6eac8f74ae4
Author: Rob Pike <r@golang.org>
Date:   Mon Dec 19 13:23:27 2011 -0800

    doc: delete go course notes
    They're out of date, a pain to maintain, and most of the material
    is better served by the Go Tour.
    
    Fixes #2101.
    
    R=golang-dev, rsc, r, adg
    CC=golang-dev
    https://golang.org/cl/5489053

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/c99f4f5bf648217987859d8afa0bd6eac8f74ae4

元コミット内容

doc: delete go course notes
They're out of date, a pain to maintain, and most of the material
is better served by the Go Tour.

Fixes #2101.

R=golang-dev, rsc, r, adg
CC=golang-dev
https://golang.org/cl/5489053

変更の背景

このコミットの主な背景は、Go言語の初期に提供されていた3日間のコースノート（PDF形式）が、時間の経過とともに古くなり、内容の維持が困難になったことです。これらのコースノートは、Go言語の基本的な概念、型、並行処理などを解説していましたが、言語の進化や新しい学習リソースの登場により、その役割を終えることになりました。

特に重要な背景として、Go言語の公式なインタラクティブ学習ツールである「A Tour of Go」（通称「Go Tour」）の存在が挙げられます。Go Tourは、ブラウザ上でGoコードを記述・実行しながら学習できるため、静的なPDFドキュメントよりもはるかに効果的で最新の情報を提供できます。コミットメッセージにもあるように、「ほとんどの資料はGo Tourによってより良く提供される」という認識が、コースノート削除の決定的な理由となりました。

また、Fixes #2101という記述から、この変更がGitHubのIssue #2101に対応していることがわかります。このIssueは、おそらく古いドキュメントの削除や更新に関するものであったと推測されます。古い、あるいは誤解を招く可能性のあるドキュメントを削除し、より正確で最新のリソースに誘導することは、プロジェクトのドキュメント品質を維持する上で非常に重要です。

前提知識の解説

Go言語のコースノート

Go言語の初期には、開発者向けの学習資料として、PDF形式の「Go Course Notes」が提供されていました。これらは、Go言語の基本的な構文、型システム、メソッド、インターフェース、そして特にGoの強みである並行処理（goroutinesとchannels）について、3日間のコース形式で構成されていました。しかし、プログラミング言語は常に進化するため、初期の資料はすぐに古くなり、最新の言語仕様やベストプラクティスとは異なる内容を含む可能性があります。

A Tour of Go (Go Tour)

「A Tour of Go」は、Go言語の公式ウェブサイトで提供されている、インタラクティブな学習ツールです。ユーザーはウェブブラウザ上でGoのコードスニペットを読み、実行し、変更することができます。このツールは、Go言語の基本的な概念から高度な機能までを段階的に学ぶことができ、実際のコードを動かしながら理解を深めることができるため、非常に効果的な学習方法として広く利用されています。Go Tourは常に最新のGo言語の仕様に合わせて更新されるため、古い静的なドキュメントよりも信頼性が高く、推奨される学習リソースとなっています。

doc/docs.html、doc/go_tutorial.html、doc/go_tutorial.tmpl

これらはGo言語の公式ドキュメントサイトの一部を構成するHTMLファイルおよびテンプレートファイルです。

  • doc/docs.html: Go言語のドキュメントの概要ページや、様々なドキュメントへのリンクがまとめられている可能性のあるファイルです。
  • doc/go_tutorial.html: Go言語の基本的なチュートリアルコンテンツを含むHTMLファイルです。
  • doc/go_tutorial.tmpl: go_tutorial.htmlの生成に使用されるテンプレートファイルである可能性が高いです。テンプレートファイルは、動的にコンテンツを生成する際に利用され、共通のレイアウトや構造を定義するのに役立ちます。

これらのファイルは、ユーザーがGo言語の学習リソースにアクセスする際の入り口となるため、古いコースノートへのリンクを削除し、Go Tourへのリンクを適切に配置することが重要でした。

技術的詳細

このコミットは、主に以下の2つの技術的な変更を含んでいます。

  1. 古いPDFドキュメントの削除:

    • doc/GoCourseDay1.pdf
    • doc/GoCourseDay2.pdf
    • doc/GoCourseDay3.pdf これらのバイナリファイルは、リポジトリから完全に削除されました。これにより、これらの古い、メンテナンスされていない資料が誤って参照されることを防ぎます。Gitの差分表示では、バイナリファイルの削除は「Bin [サイズ] -> 0 bytes」として表示されます。

  2. ドキュメント内の参照の更新:

    • doc/docs.html
    • doc/go_tutorial.html
    • doc/go_tutorial.tmpl これらのHTMLファイルおよびテンプレートファイルから、削除されたPDFコースノートへのリンクが削除されました。同時に、go_tutorial.htmlとgo_tutorial.tmplでは、古いコースノートへの言及を削除し、代わりに「A Tour of Go」へのリンクが追加されました。これは、ユーザーを最新かつ推奨される学習リソースに誘導するための重要な変更です。HTMLの変更は、<p>タグや<ul>タグ内のリンク要素の削除、および新しい<a href>タグの追加によって行われています。

これらの変更は、Go言語のドキュメントの整合性と最新性を保つために行われました。古い、誤解を招く可能性のある情報を削除し、より優れた代替手段を提示することで、ユーザーエクスペリエンスを向上させています。

コアとなるコードの変更箇所

このコミットで変更されたファイルと、その差分は以下の通りです。

--- a/doc/GoCourseDay1.pdf
+++ /dev/null
deleted file mode 100644
index 5a7749c18e..0000000000
Binary files a/doc/GoCourseDay1.pdf and /dev/null differ
--- a/doc/GoCourseDay2.pdf
+++ /dev/null
deleted file mode 100644
index 0d82ba4d32..0000000000
Binary files a/doc/GoCourseDay2.pdf and /dev/null differ
--- a/doc/GoCourseDay3.pdf
+++ /dev/null
deleted file mode 100644
index 5a5463ba2b..0000000000
Binary files a/doc/GoCourseDay3.pdf and /dev/null differ
--- a/doc/docs.html
+++ b/doc/docs.html
@@ -33,17 +33,6 @@ concepts: syntax, types, allocation, constants, I/O, sorting, printing,
 goroutines, and channels.
 </p>
 
-<h3 id=\"course_notes\">Course Notes</h3>
-<p>
-Slides from a 3-day course about the Go programming language.
-A more thorough introduction than the tutorial.
-</p>
-<ul>
-<li><a href=\"GoCourseDay1.pdf\">Day 1: Basics</a> <small>[270KB PDF]</small></li>
-<li><a href=\"GoCourseDay2.pdf\">Day 2: Types, Methods, Interfaces</a> <small>[270KB PDF]</small></li>
-<li><a href=\"GoCourseDay3.pdf\">Day 3: Concurrency and Communication</a> <small>[180KB PDF]</small></li>
-</ul>
-
 <h3 id=\"effective_go\"><a href=\"effective_go.html\">Effective Go</a></h3>
 <p>
 A document that gives tips for writing clear, idiomatic Go code.
--- a/doc/go_tutorial.html
+++ b/doc/go_tutorial.html
@@ -15,11 +15,8 @@ After you've read this tutorial, you should look at
 <a href='/doc/effective_go.html'>Effective Go</a>,
 which digs deeper into how the language is used and
 talks about the style and idioms of programming in Go.
-Also, slides from a 3-day course about Go are available.
-They provide some background and a lot of examples:
-<a href='/doc/GoCourseDay1.pdf'>Day 1</a>,
-<a href='/doc/GoCourseDay2.pdf'>Day 2</a>,
-<a href='/doc/GoCourseDay3.pdf'>Day 3</a>.
+An interactive introduction to Go is available, called
+<a href='http://tour.golang.org/'>A Tour of Go</a>.
 <p>
 The presentation here proceeds through a series of modest programs to illustrate
 key features of the language. All the programs work (at time of writing) and are
--- a/doc/go_tutorial.tmpl
+++ b/doc/go_tutorial.tmpl
@@ -11,11 +11,8 @@ After you've read this tutorial, you should look at
 <a href='/doc/effective_go.html'>Effective Go</a>,
 which digs deeper into how the language is used and
 talks about the style and idioms of programming in Go.
-Also, slides from a 3-day course about Go are available.
-They provide some background and a lot of examples:
-<a href='/doc/GoCourseDay1.pdf'>Day 1</a>,
-<a href='/doc/GoCourseDay2.pdf'>Day 2</a>,
-<a href='/doc/GoCourseDay3.pdf'>Day 3</a>.
+An interactive introduction to Go is available, called
+<a href='http://tour.golang.org/'>A Tour of Go</a>.
 <p>
 The presentation here proceeds through a series of modest programs to illustrate
 key features of the language. All the programs work (at time of writing) and are

コアとなるコードの解説

doc/GoCourseDay1.pdf, doc/GoCourseDay2.pdf, doc/GoCourseDay3.pdf

これらのファイルは、Go言語の3日間のコースノートのPDF版です。コミットでは、これらのファイルが完全に削除されています。これは、これらの資料が古く、メンテナンスが困難であり、Go Tourというより優れた代替手段が存在するためです。

doc/docs.html

このファイルでは、Goコースノートへの参照が削除されています。具体的には、以下のHTMLブロックが削除されました。

<h3 id="course_notes">Course Notes</h3>
<p>
Slides from a 3-day course about the Go programming language.
A more thorough introduction than the tutorial.
</p>
<ul>
<li><a href="GoCourseDay1.pdf">Day 1: Basics</a> <small>[270KB PDF]</small></li>
<li><a href="GoCourseDay2.pdf">Day 2: Types, Methods, Interfaces</a> <small>[270KB PDF]</small></li>
<li><a href="GoCourseDay3.pdf">Day 3: Concurrency and Communication</a> <small>[180KB PDF]</small></li>
</ul>

この変更により、Go言語の公式ドキュメントサイトのメインページまたは関連ドキュメントページから、古いコースノートへのリンクが完全に削除され、ユーザーが誤って古い情報にアクセスするのを防ぎます。

doc/go_tutorial.html および doc/go_tutorial.tmpl

これらのファイルは、Go言語のチュートリアルに関連するHTMLファイルとテンプレートファイルです。ここでは、古いコースノートへの言及が削除され、代わりに「A Tour of Go」へのリンクが追加されています。

変更前:

Also, slides from a 3-day course about Go are available.
They provide some background and a lot of examples:
<a href='/doc/GoCourseDay1.pdf'>Day 1</a>,
<a href='/doc/GoCourseDay2.pdf'>Day 2</a>,
<a href='/doc/GoCourseDay3.pdf'>Day 3</a>.

変更後:

An interactive introduction to Go is available, called
<a href='http://tour.golang.org/'>A Tour of Go</a>.

この変更により、チュートリアルを読んだユーザーが次に進むべき学習リソースとして、古くなったPDFではなく、インタラクティブで最新の「A Tour of Go」が明確に推奨されるようになりました。これは、ユーザーがGo言語を効果的に学習するためのパスを最適化する上で非常に重要な変更です。

関連リンク

参考にした情報源リンク