Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

テキストにDevToolsの内容を追加 #134

Merged
merged 4 commits into from
May 30, 2024
Merged

Conversation

mathsuky
Copy link
Contributor

DevToolsについてのテキストを作成しました。
内容もそうですが,これをおく場所もここで良いのかがわからないのでアドバイスいただければと思います。

@mathsuky mathsuky requested review from Pugma and ramdos0207 May 13, 2024 07:13
@mathsuky
Copy link
Contributor Author

今年の講師陣にレビューお願いしようと思ったらAlterくんが見つけられなかった...

@cp-20 cp-20 requested a review from alter334 May 16, 2024 12:38
@cp-20
Copy link
Contributor

cp-20 commented May 16, 2024

↑SysAdチームに入っていなかったからなので、入れた

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

カンマじゃなくて読点に統一したいです


![DevTools-main](./images/DevTools-main.png)

併せて,ショートカットを利用してDevToolsを開く方法を紹介します。WindowsまたはLinuxの場合は`Ctrl+Shift+C`で,Macの場合は`Cmd+Option+C`でDevToolsのElement(要素)タブを開くことができます。そのほかにもいくつかのショートカットがあり,詳細は[このページ](https://developer.chrome.com/docs/devtools/open?hl=ja)を参照してください。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

F12の方が一般的だと思ってたけどどうなんだろ(ctrl+shift+c知らなかった)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

↑わかる (ボクはCtrl+Shift+I派)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

F12 の方が一般的ではあると思うのでそっちを書きたいかも? (Fn + F12 の人もいるのでそこもカバーしてほしいです)

### Consoleについて
次に,Consoleについて説明します。
DevToolsを開いてConsoleタブを選択すると,次のような画面が表示されると思います。
<!-- 写真 -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここって画像入れ忘れですか?

次に,Consoleについて説明します。
DevToolsを開いてConsoleタブを選択すると,次のような画面が表示されると思います。
<!-- 写真 -->
ここにはアプリケーションのすべてのログやエラーが表示されます。これを見ることにより,開発中に生じたエラーの詳細がわかり,エラーを解決するための手助けとなります。また,ConsoleではJavaScriptのコードを実行することもできます。例えば,次のようなコードをConsoleに直接入力してみてください。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

console.log仕込んでデバッグに使えることも書きたいです


![DevTools-Network-Detail](./images/DevTools-Network-Detail.png)

### Applicationについて
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cookieいじれることも書いておきたいかもです

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

devtoolsってデフォルトで下に表示されるように気がするので、右側に移動する方法も書いておくといいかもです

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chromeはデフォルトで右側な気がします (要出典)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

僕が今のPC使い始めたときは下だったはずだけど変わったのかな🤔(右側で使うという方法があることを2年か3年で知ったので)


併せて,ショートカットを利用してDevToolsを開く方法を紹介します。WindowsまたはLinuxの場合は`Ctrl+Shift+C`で,Macの場合は`Cmd+Option+C`でDevToolsのElement(要素)タブを開くことができます。そのほかにもいくつかのショートカットがあり,詳細は[このページ](https://developer.chrome.com/docs/devtools/open?hl=ja)を参照してください。

## DevToolsの機能の紹介
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://traptitech.github.io/naro-text/chapter1/section2/0_vue-intro.html#vue-dev-tool でvueのdevtoos拡張入れさせるので、軽く触れてもいいかもです

Copy link
Contributor

@cp-20 cp-20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

全体的にはすごい良い内容だと思います! いくつか気になる点だけコメントしました!

@@ -0,0 +1,90 @@
# DevToolsについて
この章では,Webアプリ開発において欠かせないChrome DevToolsについて説明します。この章では基本的な内容に絞って説明していますので,DevToolsについてより詳細に知りたい人は[公式のドキュメント](https://developer.chrome.com/docs/devtools?hl=ja)を参照してください。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DevTools自体はChromeに限らない概念なので、上手くそこら辺を説明して欲しい感じある DevToolsはそれぞれのブラウザにあるけど、今回はChromeを例にとって説明するね、みたいな


![DevTools-main](./images/DevTools-main.png)

併せて,ショートカットを利用してDevToolsを開く方法を紹介します。WindowsまたはLinuxの場合は`Ctrl+Shift+C`で,Macの場合は`Cmd+Option+C`でDevToolsのElement(要素)タブを開くことができます。そのほかにもいくつかのショートカットがあり,詳細は[このページ](https://developer.chrome.com/docs/devtools/open?hl=ja)を参照してください。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

リンクは「このページ」とかではなく、中身を書いた方が良いとされている

ref: https://smarthr.design/accessibility/link-text/


![DevTools-main](./images/DevTools-main.png)

併せて,ショートカットを利用してDevToolsを開く方法を紹介します。WindowsまたはLinuxの場合は`Ctrl+Shift+C`で,Macの場合は`Cmd+Option+C`でDevToolsのElement(要素)タブを開くことができます。そのほかにもいくつかのショートカットがあり,詳細は[このページ](https://developer.chrome.com/docs/devtools/open?hl=ja)を参照してください。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

↑わかる (ボクはCtrl+Shift+I派)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chromeはデフォルトで右側な気がします (要出典)


Applicationの項目にはマニフェスト(manifest.jsonに含まれる名前やversionなどの情報),Service Worker(ウェブアプリケーション,ブラウザー,そしてネットワークの間に介在するプロキシサーバーのように振る舞うもの),ストレージなどアプリに関する全般的な情報が含まれます。

Storageの項目には使用されているさまざまなストレージ方法が含まれており,編集することもできます。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

日本語がちょっとびみょいかも?

Copy link
Member

@Takeno-hito Takeno-hito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ちょい足し


![DevTools-main](./images/DevTools-main.png)

併せて,ショートカットを利用してDevToolsを開く方法を紹介します。WindowsまたはLinuxの場合は`Ctrl+Shift+C`で,Macの場合は`Cmd+Option+C`でDevToolsのElement(要素)タブを開くことができます。そのほかにもいくつかのショートカットがあり,詳細は[このページ](https://developer.chrome.com/docs/devtools/open?hl=ja)を参照してください。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

F12 の方が一般的ではあると思うのでそっちを書きたいかも? (Fn + F12 の人もいるのでそこもカバーしてほしいです)

@mathsuky
Copy link
Contributor Author

指摘いただいた内容についてほぼ修正したと思いますので,追加の確認などお願いいたします。
ただ,しーぴーくんに指摘いただいたApplitcationの章の日本語がどうしても綺麗にできなかったので,助言いただきたいです:pray:

@mathsuky
Copy link
Contributor Author

自分があまりApplicationの内容を開発で使ったことがないのもあって,どのような内容を初心者に伝えればわかっていないのが読みづらい原因の一つではあると思うので,その点などアドバイスいただけるとありがたいです。

@cp-20
Copy link
Contributor

cp-20 commented May 20, 2024

指摘いただいた内容についてほぼ修正したと思いますので,追加の確認などお願いいたします。 ただ,しーぴーくんに指摘いただいたApplitcationの章の日本語がどうしても綺麗にできなかったので,助言いただきたいです:pray:

レビューが分かりづらくてごめんなんだけど、ストレージの方に言及してた

Copy link
Contributor

@cp-20 cp-20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

全体的にはすごい良くなってそうで流石です! 余裕あれば程度で1点だけコメントしました!

@@ -0,0 +1,104 @@
# DevToolsについて
この章では、Webアプリ開発において欠かせないDevToolsについて説明します。この章では基本的な内容に絞って説明していますので、DevToolsについてより詳細に知りたい人は[公式のドキュメント](https://developer.chrome.com/docs/devtools?hl=ja)を参照してください。なお、DevToolsはさまざまなWebブラウザにある機能ですが、今回はChrome DevToolsを題材に話を進めます。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[ntis] めちゃ細かい話だけど、DevToolsの公式ドキュメントとしてChromeが上がると (あながち間違いではないが) ちょいもやっとするかも Chrome DevToolsの公式ドキュメントとして紹介する方がスッキリするかも

@mathsuky
Copy link
Contributor Author

mathsuky commented May 22, 2024

しーぴーくんにいただいた指摘(#134 (comment)) を修正しました!確認よろしくお願いします:pray:

@mathsuky
Copy link
Contributor Author

講師陣以外の方もレビューリクエスト出させていただきましたが,余裕あればで大丈夫です:pray:

Copy link
Contributor

@cp-20 cp-20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

良さそう!

Copy link
Member

@Takeno-hito Takeno-hito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Takeno-hito Takeno-hito merged commit 0d2c9d5 into main May 30, 2024
3 checks passed
@Takeno-hito Takeno-hito deleted the addTextAboutDevtools branch May 30, 2024 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants