SlideShare a Scribd company logo
情報を表現するときのポイント
2024-05-16 / 第112回社内勉強会
onozaty
1
情報を表現するときのポイント
Issueやチケット、チャットなど、情報を書いて伝える場面がたくさんあります。
情報を表現するときのポイントについて、3つほど紹介したいと思います。
2
ポイント
1. 記法を使いこなす
2. 文章で表現しづらいものは画像を使う
3. 画像でも表現しづらいものは、アニメーションをつかう
3
1. 記法を使いこなす
4
1. 記法を使いこなす
テキストで書くようなものには、様々な記法が用意されています。
これを使うことで、単純な文章として書くより、表現力をあげることができます。
記法として良く使われるのはMarkdownです。
Markdown記法の中で、さらに(個人的に)頻繁に使うと思うものを紹介します。
5
Markdown - 見出し
入力
# 見出し1
## 見出し2
### 見出し3
表示
見出し1
見出し2
見出し3
6
Markdown - リスト
入力
- リスト1
- リスト1-1
- リスト1-1-1 ちゃんと折り返す
- リスト1-2
- リスト2
- リスト3
表示
リスト1
リスト1-1
リスト1-1-1 ちゃんと折り
返す
リスト1-2
リスト2
リスト3
リストの記号は - だけでなく、 * や + でもOKです。
7
Markdown - 番号付きリスト
入力
1. リスト1
1. リスト1-1
1. リスト1-1-1 ちゃんと折り返す
2. リスト1-2
2. リスト2
3. リスト3
表示
1. リスト1
i. リスト1-1
a. リスト1-1-1 ちゃんと折り
返す
ii. リスト1-2
2. リスト2
3. リスト3
リストの数字は最初の数字からの連番になります。
なので、全部同じ数字でも問題ありません。(全部 1. でも同じ表示になる)
8
Markdown - コード(ブロック)
入力
```java
public static void main(String[] args) {
System.out.println("Hello, world.");
}
```
表示
public static void main(String[] args) {
System.out.println("Hello, world.");
}
``` の後に識別子となる情報(プログラミング言語名など)を指定することで、シンタ
ックスハイライトでの表示となって読みやすくなります。
9
Markdown - コード(ブロック)
何かの差を表現したい時には、 diff を使うとわかりやすいです。
(たとえばコードの修正イメージ)
入力
```diff
public static void main(String[] args) {
- System.out.println("Hello, world.");
+ System.out.println("こんにちは世界!");
}
```
表示
public static void main(String[] args) {
- System.out.println("Hello, world.");
+ System.out.println("こんにちは世界!");
}
10
Markdown - コード(インライン)
入力
`String`の`replace`メソッドを使う。
表示
String の replace メソッドを使う。
11
Markdown - リンク
入力
[Google](https://www.google.com)
https://www.google.com
表示
Google
https://www.google.com
サイトのタイトルを表示名にしたいような場合、上記のようなものを手で書くのは面
倒です。
ブラウザの拡張で、現在表示しているページのリンクをMarkdown形式で作ってくれる
ようなツールがたくさんありますので、それを使うと良いでしょう。
Create Link - Chrome Web Store
12
Markdown - 引用
入力
> ここが引用です。
この行は引用じゃないです。
表示
ここが引用です。
この行は引用じゃないです。
13
Markdown - 太字、取り消し線
入力
太字で**強調**できます。
~~採り消し~~取り消し線で修正を表せます。
表示
太字で強調できます。
採り消し取り消し線で修正を表せます。
14
1. 記法を使いこなす
Markdownでも、そのツール特有の記法があったりします。
ツール特有の情報(Issueやチケット、Wikiなど)へのリンク
メンション など...
一度そのツールでの記法をざっと確認してみると、便利な使い方があるかもしれませ
ん。(あとは、既に書いているものをみてみるとか)
たいてい入力欄の近くに記法に関するヘルプのリンクがあると思いますので、そこか
ら参照してみてください。
15
2. 文章で表現しづらいものは画像を使う
16
2. 文章で表現しづらいものは画像を使う
文章で説明するより、画像で見た方がすぐわかるようなことも多々あります。
たとえばWebアプリケーションで表示崩れがあった場合に、文章で説明するのは難し
いですが、ブラウザで表示した際のスクリーンショット画像があれば、それだけで伝
わります。
ただし、スクリーンショットが楽ということで、なんでもかんでも画像にしてしまう
のは控えましょう。
たとえば、ログやエラーメッセージのような、文字情報として有用なものを画像にし
てしまうと、後から文字として検索できなくなってしまいます。
17
Snipping Tool / 切り取り&スケッチ
Windowsならば標準で入っている Snipping Tool / 切り取り&スケッチ で簡単にキャプ
チャできます。
Snipping Tool を使ってスクリーン ショットをキャプチャする - Microsoft サポー
ト
18
Snipping Tool / 切り取り&スケッチ
※アニメーションGIFなので環境によっては動きません
19
Screenpresso
Snipping Tool / 切り取り&スケッチ でもちょっとした加工ができますが、私は枠線や
テキストを入れたくて、ScreenpressoのPro版を購入して使っています。
Screenpresso:Windows用の究極のスクリーンキャプチャツール
Screenpresso の無償版でも枠線やテキストを入れられるので、Snipping Toolで編集弱
いな、、と思ったらぜひお試しください。おすすめです。
20
Screenpresso
※アニメーションGIFなので環境によっては動きません
21
3. 画像でも表現しづらいものは、アニメーションをつかう
22
3. 画像でも表現しづらいものは、アニメーションをつかう
動きがあるようなものは、画像ではなくアニメーションにすると、さらに伝わりやす
くなります。
また、伝える方としても、画像をたくさん張り付けたり、文章で動きを補足したりな
どする必要もなく、手間を減らすことができます。
23
ScreenToGif
Windows だと ScreenToGif というOSSのソフトがとても便利です。
ScreenToGif
これを使うと、とても簡単に、画面上の操作を撮影して、アニメーションGIFとして保
存できます。
24
ScreenToGif
※アニメーションGIFなので環境によっては動きません 25
おわり
26

More Related Content

More from onozaty

Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020
Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020
Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020
onozaty
 
「伝わるチケット」の書き方
「伝わるチケット」の書き方「伝わるチケット」の書き方
「伝わるチケット」の書き方
onozaty
 
View customize plugin for Redmineの紹介 (2019年版)
View customize plugin for Redmineの紹介 (2019年版)View customize plugin for Redmineの紹介 (2019年版)
View customize plugin for Redmineの紹介 (2019年版)
onozaty
 
View customize1.2.0の紹介
View customize1.2.0の紹介View customize1.2.0の紹介
View customize1.2.0の紹介
onozaty
 
WebSocketでカメラの映像を共有してみた
WebSocketでカメラの映像を共有してみたWebSocketでカメラの映像を共有してみた
WebSocketでカメラの映像を共有してみた
onozaty
 
Lombokの紹介
Lombokの紹介Lombokの紹介
Lombokの紹介
onozaty
 
Spring Bootを触ってみた
Spring Bootを触ってみたSpring Bootを触ってみた
Spring Bootを触ってみた
onozaty
 
30歳過ぎてもエンジニアでいるためにやったこと
30歳過ぎてもエンジニアでいるためにやったこと30歳過ぎてもエンジニアでいるためにやったこと
30歳過ぎてもエンジニアでいるためにやったこと
onozaty
 
View customize pluginを使いこなす
View customize pluginを使いこなすView customize pluginを使いこなす
View customize pluginを使いこなす
onozaty
 
View Customize Pluginで出来ること
View Customize Pluginで出来ることView Customize Pluginで出来ること
View Customize Pluginで出来ること
onozaty
 
技術書のススメ
技術書のススメ技術書のススメ
技術書のススメ
onozaty
 
課題管理と情報共有のためのツール群
課題管理と情報共有のためのツール群課題管理と情報共有のためのツール群
課題管理と情報共有のためのツール群
onozaty
 
お試し用のLinux環境を作る
お試し用のLinux環境を作るお試し用のLinux環境を作る
お試し用のLinux環境を作る
onozaty
 
業務で使うIRC
業務で使うIRC業務で使うIRC
業務で使うIRConozaty
 

More from onozaty (14)

Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020
Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020
Redmineの画面をあなた好みにカスタマイズ - View customize pluginの紹介 - Redmine Japan 2020
 
「伝わるチケット」の書き方
「伝わるチケット」の書き方「伝わるチケット」の書き方
「伝わるチケット」の書き方
 
View customize plugin for Redmineの紹介 (2019年版)
View customize plugin for Redmineの紹介 (2019年版)View customize plugin for Redmineの紹介 (2019年版)
View customize plugin for Redmineの紹介 (2019年版)
 
View customize1.2.0の紹介
View customize1.2.0の紹介View customize1.2.0の紹介
View customize1.2.0の紹介
 
WebSocketでカメラの映像を共有してみた
WebSocketでカメラの映像を共有してみたWebSocketでカメラの映像を共有してみた
WebSocketでカメラの映像を共有してみた
 
Lombokの紹介
Lombokの紹介Lombokの紹介
Lombokの紹介
 
Spring Bootを触ってみた
Spring Bootを触ってみたSpring Bootを触ってみた
Spring Bootを触ってみた
 
30歳過ぎてもエンジニアでいるためにやったこと
30歳過ぎてもエンジニアでいるためにやったこと30歳過ぎてもエンジニアでいるためにやったこと
30歳過ぎてもエンジニアでいるためにやったこと
 
View customize pluginを使いこなす
View customize pluginを使いこなすView customize pluginを使いこなす
View customize pluginを使いこなす
 
View Customize Pluginで出来ること
View Customize Pluginで出来ることView Customize Pluginで出来ること
View Customize Pluginで出来ること
 
技術書のススメ
技術書のススメ技術書のススメ
技術書のススメ
 
課題管理と情報共有のためのツール群
課題管理と情報共有のためのツール群課題管理と情報共有のためのツール群
課題管理と情報共有のためのツール群
 
お試し用のLinux環境を作る
お試し用のLinux環境を作るお試し用のLinux環境を作る
お試し用のLinux環境を作る
 
業務で使うIRC
業務で使うIRC業務で使うIRC
業務で使うIRC
 

Recently uploaded

LoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアル
LoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアルLoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアル
LoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアル
CRI Japan, Inc.
 
遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化
遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化
遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化
t m
 
JSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさ
JSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさJSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさ
JSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさ
0207sukipio
 
論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...
論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...
論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...
Toru Tamaki
 
This is the company presentation material of RIZAP Technologies, Inc.
This is the company presentation material of RIZAP Technologies, Inc.This is the company presentation material of RIZAP Technologies, Inc.
This is the company presentation material of RIZAP Technologies, Inc.
chiefujita1
 
ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---
ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---
ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---
Matsushita Laboratory
 
TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024
TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024
TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024
Matsushita Laboratory
 
CS集会#13_なるほどわからん通信技術 発表資料
CS集会#13_なるほどわからん通信技術 発表資料CS集会#13_なるほどわからん通信技術 発表資料
CS集会#13_なるほどわからん通信技術 発表資料
Yuuitirou528 default
 

Recently uploaded (8)

LoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアル
LoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアルLoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアル
LoRaWAN 4チャンネル電流センサー・コンバーター CS01-LB 日本語マニュアル
 
遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化
遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化
遺伝的アルゴリズムと知識蒸留による大規模言語モデル(LLM)の学習とハイパーパラメータ最適化
 
JSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさ
JSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさJSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさ
JSAI_類似画像マッチングによる器への印象付与手法の妥当性検証_ver.3_高橋りさ
 
論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...
論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...
論文紹介:When Visual Prompt Tuning Meets Source-Free Domain Adaptive Semantic Seg...
 
This is the company presentation material of RIZAP Technologies, Inc.
This is the company presentation material of RIZAP Technologies, Inc.This is the company presentation material of RIZAP Technologies, Inc.
This is the company presentation material of RIZAP Technologies, Inc.
 
ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---
ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---
ReonHata_便利の副作用に気づかせるための発想支援手法の評価---行為の増減の提示による気づきへの影響---
 
TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024
TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024
TaketoFujikawa_物語のコンセプトに基づく情報アクセス手法の基礎検討_JSAI2024
 
CS集会#13_なるほどわからん通信技術 発表資料
CS集会#13_なるほどわからん通信技術 発表資料CS集会#13_なるほどわからん通信技術 発表資料
CS集会#13_なるほどわからん通信技術 発表資料
 

情報を表現するときのポイント