Skip to content

コマンドとその出力を同一コードブロック内に記載すると混乱を招く #942

@chvmvd

Description

@chvmvd

現在、一部の箇所でコマンドとその出力が同一コードブロック内に記載されており、それにより混乱を招いている。

例えば、SSHの公開鍵を出力する場面においては、全学自由研究ゼミナールでコードブロックの内容全体をコマンドと勘違いした事例が散見された他、2026年3月3日にはコードブロック内のコマンドとその出力結果を分けていないことで混乱を招いているという指摘が報告された。
cf.

```shell
$ cat ~/.ssh/id_ed25519.pub
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEqE0cyVkFSFD/BlAwvJ9QejXwgyFppn5JDQc8iGW/Gp [ユーザー名]@[コンピューター名]
```

以上のようなことを防ぐため、次の3つの対策案を考えた。

  • コマンドと、コマンドとその出力結果を別のコードブロックに記載する。例えば、Node.jsがインストールされているかを確認する場面では、コマンドとその出力結果を別のコードブロックに分けている。cf.
    完了したら、Node.jsのインストールが完了しているか確認するため、次のコマンドを実行します。
    ```shell
    node -v
    ```
    次のように表示されたら成功です。
    ```shell
    $ node -v
    v22.15.0
    ```
  • コマンドを記載したコードブロックは置かず、スクリーンショットのみを置く。スクリーンショットにすることで、どこがコマンドでどこが出力結果であるかが分かりやすいようにする。また、直接コマンドをコピーできなくなるため、出力結果ごとコピペしてしまうことを防ぐことができる。
  • 教材中ではこれ以降$の後にコマンドを記載するようにするということを説明する。これにより、教材が冗長でなくなる。

以上の対策案のうち、教材内で冗長な表現になることを防ぐため一旦3つ目の案を採用することにする。1つ目の案では、コマンドと、コマンドとその出力結果を別のコードブロックに記載するため、教材が冗長になってしまうことなどが理由である。もし問題が生じた場合は、今後他の案を検討することにする。

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions