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

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

このコミットは、Go言語の公式ドキュメントに、Goコードの書き方に関するスクリーキャスト（動画解説）へのリンクを追加するものです。具体的には、doc/code.htmlとdoc/docs.htmlの2つのHTMLファイルが更新され、Goコマンド（go command）の利用方法を説明するセクションに、対応するYouTube動画へのハイパーリンクが埋め込まれています。これにより、ユーザーはテキストベースのドキュメントだけでなく、視覚的な解説を通じてGoの基本的な開発フローを学ぶことができるようになります。

コミット

commit 6f9609ab3bafb62dcc224604fccdc4f75fc60906
Author: Andrew Gerrand <adg@golang.org>
Date:   Tue Nov 13 16:50:44 2012 +0100

    doc: link to Go coding screencast
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/6849046

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

https://github.com/golang/go/commit/6f9609ab3bafb62dcc224604fccdc4f75fc60906

元コミット内容

doc: link to Go coding screencast

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/6849046

変更の背景

このコミットの背景には、Go言語の学習リソースを多様化し、ユーザーがよりアクセスしやすい形で情報を提供したいという意図があります。特に、Go言語の基本的な開発ツールであるgo commandの使い方は、初心者にとって最初の障壁となることがあります。テキストドキュメントだけでは理解しにくい概念や手順も、スクリーキャスト（画面録画による解説動画）を用いることで、視覚的に、かつ実践的なデモンストレーションを通じて効率的に伝えることが可能になります。

この変更は、Go言語のドキュメントが単なるリファレンスとしてだけでなく、学習ガイドとしての役割も強化しようとする取り組みの一環と見られます。動画コンテンツへのリンクを追加することで、ユーザーは自分の学習スタイルに合わせて最適なリソースを選択できるようになり、Go言語への参入障壁を低減し、より多くの開発者がGoを学び始めるきっかけを提供します。

前提知識の解説

  • Go言語 (Golang): Googleによって開発されたオープンソースのプログラミング言語です。シンプルさ、効率性、並行処理のサポートが特徴で、Webサービス、ネットワークプログラミング、CLIツールなどで広く利用されています。
  • go command: Go言語の公式ツールチェーンの中核をなすコマンドラインツールです。Goプログラムのビルド、テスト、パッケージの管理（ダウンロード、インストール）、フォーマット、ドキュメント生成など、Go開発におけるほとんどの作業をこのコマンド一つで行うことができます。例えば、go buildで実行可能ファイルを生成したり、go getで外部パッケージをダウンロードしたりします。
  • スクリーキャスト (Screencast): コンピュータの画面操作を録画した動画コンテンツのことです。ソフトウェアのデモンストレーション、チュートリアル、プレゼンテーションなどでよく用いられます。本コミットでは、Goコードの書き方やgo commandの使い方を視覚的に解説する動画を指します。
  • HTML (HyperText Markup Language): ウェブページを作成するための標準的なマークアップ言語です。ウェブブラウザが解釈し、テキスト、画像、リンクなどを表示します。
  • doc/code.html: Go言語の公式ドキュメントの一部で、「How to write Go code」というタイトルでGoコードの基本的な書き方やgo commandの利用方法について解説しているHTMLファイルです。
  • doc/docs.html: Go言語の公式ドキュメントのインデックスページまたは主要なドキュメントへのリンク集を提供するHTMLファイルです。様々なドキュメントへのナビゲーションを提供します。
  • コミット (Commit): バージョン管理システム（Gitなど）において、ファイルやディレクトリの変更を記録する操作です。一連の変更を一つのまとまりとして保存し、後からその変更内容を追跡したり、元に戻したりすることができます。
  • diff: 2つのファイルやテキストの差分を表示するコマンドまたはその出力です。Gitでは、コミットに含まれる変更内容を視覚的に確認するために利用されます。緑色の行は追加された内容、赤色の行は削除された内容を示します。

技術的詳細

このコミットは、Go言語の公式ドキュメントのHTMLファイルを直接編集することで、スクリーキャストへのリンクを追加しています。変更は主に以下の2つのファイルで行われています。

  1. doc/code.html:

    • このファイルは「How to write Go code」というセクションの冒頭に、新しい<p>タグを追加しています。
    • 追加された<p>タグ内には、「This content is also available as a screencast.」というテキストと、YouTubeの動画（http://www.youtube.com/watch?v=XCsL89YtqCs）へのハイパーリンクが含まれています。
    • これにより、Goコマンドの紹介直後に、動画版の解説があることを明示的に示しています。

  2. doc/docs.html:

    • このファイルは、ドキュメントのリストにある「How to write Go code」の項目を修正しています。
    • 既存の段落の内容が変更され、Goコマンドの説明に加えて、このドキュメントがスクリーキャストとしても利用可能である旨が追記されています。
    • 具体的には、「Also available as a screencast, this doc explains how to use the go command...」という形で、動画へのリンクが埋め込まれています。
    • ここでも、http://www.youtube.com/watch?v=XCsL89YtqCsへのリンクが使用されています。

これらの変更は、HTMLの基本的な<a>タグ（アンカータグ）とhref属性を用いてハイパーリンクを生成し、<p>タグ（段落）内に配置するという、標準的なウェブコンテンツの編集手法に従っています。既存のドキュメント構造を大きく変更することなく、補足情報として動画コンテンツへの導線を設けることで、ユーザーエクスペリエンスの向上を図っています。

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

diff --git a/doc/code.html b/doc/code.html
index d11685f796..096f5bfc9e 100644
--- a/doc/code.html
+++ b/doc/code.html
@@ -10,6 +10,10 @@ introduces the <a href="/cmd/go/">go command</a>, the standard way to fetch,
 build, and install Go packages and commands.
 </p>
 
+<p>
+This content is also available as a <a href="http://www.youtube.com/watch?v=XCsL89YtqCs">screencast</a>.
+</p>
+\
 
 <h2 id="GOPATH">Code organization</h2>
 
diff --git a/doc/docs.html b/doc/docs.html
index 1f9ae76369..9bb012a50a 100644
--- a/doc/docs.html
+++ b/doc/docs.html
@@ -45,8 +45,10 @@ learned. You can <a href="http://tour.golang.org/">take the tour online</a> or
 
 <h3 id="code"><a href="code.html">How to write Go code</a></h3>
 <p>
-How to use the <a href="/cmd/go/">go command</a> to fetch, build, and install
-packages, commands, and run tests.
+Also available as a
+<a href="http://www.youtube.com/watch?v=XCsL89YtqCs">screencast</a>, this doc
+explains how to use the <a href="/cmd/go/">go command</a> to fetch, build, and
+install packages, commands, and run tests.
 </p>
 
 <h3 id="effective_go"><a href="effective_go.html">Effective Go</a></h3>

コアとなるコードの解説

上記のdiffは、2つのHTMLファイルに対する変更を示しています。

doc/code.html の変更点:

  • @@ -10,6 +10,10 @@ は、元のファイルでは10行目から6行が変更され、新しいファイルでは10行目から10行に変更されたことを示します。
  • 追加された行 (+ で始まる行) は以下の通りです。 
    <p>
This content is also available as a <a href="http://www.youtube.com/watch?v=XCsL89YtqCs">screencast</a>.
</p>
    これは、Goコマンドの紹介文の直後に、この内容がスクリーキャストとしても利用可能であることを示す新しい段落を追加しています。<a href="...">タグは、指定されたYouTube URLへのハイパーリンクを作成します。

doc/docs.html の変更点:

  • @@ -45,8 +45,10 @@ は、元のファイルでは45行目から8行が変更され、新しいファイルでは45行目から10行に変更されたことを示します。
  • 削除された行 (- で始まる行) は以下の通りです。 
    How to use the <a href="/cmd/go/">go command</a> to fetch, build, and install
packages, commands, and run tests.
    これは、「How to write Go code」セクションの元の説明文です。
  • 追加された行 (+ で始まる行) は以下の通りです。 
    Also available as a
<a href="http://www.youtube.com/watch?v=XCsL89YtqCs">screencast</a>, this doc
explains how to use the <a href="/cmd/go/">go command</a> to fetch, build, and
install packages, commands, and run tests.
    これは、元の説明文を置き換え、冒頭に「Also available as a screencast, this doc explains...」という文言と、YouTube動画へのリンクを追加しています。これにより、ドキュメントの概要部分で、動画コンテンツの存在を明示しています。

これらの変更は、Go言語のドキュメントのアクセシビリティと学習体験を向上させるための、シンプルかつ効果的なHTMLの修正です。

関連リンク

参考にした情報源リンク