Enviar búsqueda
Cargar
技術文書を書く際の、心技体
•
21 recomendaciones
•
5,957 vistas
Takahiro Kubo
Seguir
技術文書を書く際の、心技体についての解説です。 心:記事を書くときの心構え 体:技術文書の構成要素とその目的 技:各要素の書き方
Leer menos
Leer más
Datos y análisis
Denunciar
Compartir
Denunciar
Compartir
1 de 27
Descargar ahora
Descargar para leer sin conexión
Recomendados
[Basic 1] ブロックチェーンと計算機科学 / ブール代数 / 情報理論
[Basic 1] ブロックチェーンと計算機科学 / ブール代数 / 情報理論
Yuto Takei
Hubsを何度も破壊して得た知見、話します
Hubsを何度も破壊して得た知見、話します
hironroinakae
Post-quantum zk-SNARKs on Hyperledger Fabric
Post-quantum zk-SNARKs on Hyperledger Fabric
Hyperleger Tokyo Meetup
DXとかDevOpsとかのなんかいい感じのやつ 富士通TechLive
DXとかDevOpsとかのなんかいい感じのやつ 富士通TechLive
Tokoroten Nakayama
暗号技術の実装と数学
暗号技術の実装と数学
MITSUNARI Shigeo
事業の進展とデータマネジメント体制の進歩(+プレトタイプの話)
事業の進展とデータマネジメント体制の進歩(+プレトタイプの話)
Tokoroten Nakayama
フロー効率性とリソース効率性、再入門 #devlove #devkan
フロー効率性とリソース効率性、再入門 #devlove #devkan
Itsuki Kuroda
世界一わかりやすいClean Architecture
世界一わかりやすいClean Architecture
Atsushi Nakamura
Más contenido relacionado
La actualidad más candente
リクルート式 自然言語処理技術の適応事例紹介
リクルート式 自然言語処理技術の適応事例紹介
Recruit Technologies
インセプションデッキのひな形(PPT形式:ダウンロード用)
インセプションデッキのひな形(PPT形式:ダウンロード用)
A AOKI
JAWS-UG 金沢 | これだけ知っていれば LPWA
JAWS-UG 金沢 | これだけ知っていれば LPWA
SORACOM,INC
WiredTigerを詳しく説明
WiredTigerを詳しく説明
Tetsutaro Watanabe
チャットコミュニケーションの問題と心理的安全性の課題 #EOF2019
チャットコミュニケーションの問題と心理的安全性の課題 #EOF2019
Tokoroten Nakayama
技術系文書作成のコツ
技術系文書作成のコツ
Hideo Terada
ウェブ・セキュリティ基礎試験(徳丸基礎試験)の模擬試験問題
ウェブ・セキュリティ基礎試験(徳丸基礎試験)の模擬試験問題
Hiroshi Tokumaru
Reality introduction (feb 2021)
Reality introduction (feb 2021)
yuanli176
webエンジニアのためのはじめてのredis
webエンジニアのためのはじめてのredis
nasa9084
正しいものを正しくつくる
正しいものを正しくつくる
toshihiro ichitani
Snowflake Architecture and Performance(db tech showcase Tokyo 2018)
Snowflake Architecture and Performance(db tech showcase Tokyo 2018)
Mineaki Motohashi
ソフトウェア設計の学び方を考える
ソフトウェア設計の学び方を考える
増田 亨
OSSで出来るインシデント管理とサービス資産管理及び構成管理の自動化
OSSで出来るインシデント管理とサービス資産管理及び構成管理の自動化
IO Architect Inc.
Python におけるドメイン駆動設計(戦術面)の勘どころ
Python におけるドメイン駆動設計(戦術面)の勘どころ
Junya Hayashi
Redisの特徴と活用方法について
Redisの特徴と活用方法について
Yuji Otani
IT エンジニアのための 流し読み Windows - Microsoft Defender Exploit Guard
IT エンジニアのための 流し読み Windows - Microsoft Defender Exploit Guard
TAKUYA OHTA
Private Recommender Systems: How Can Users Build Their Own Fair Recommender S...
Private Recommender Systems: How Can Users Build Their Own Fair Recommender S...
joisino
Azure IoT/AI最前線
Azure IoT/AI最前線
Microsoft Azure Japan
Mongo dbを知ろう
Mongo dbを知ろう
CROOZ, inc.
Google Cloud Platform で実現するプロダクションレディ マイクロサービス
Google Cloud Platform で実現するプロダクションレディ マイクロサービス
Google Cloud Platform - Japan
La actualidad más candente
(20)
リクルート式 自然言語処理技術の適応事例紹介
リクルート式 自然言語処理技術の適応事例紹介
インセプションデッキのひな形(PPT形式:ダウンロード用)
インセプションデッキのひな形(PPT形式:ダウンロード用)
JAWS-UG 金沢 | これだけ知っていれば LPWA
JAWS-UG 金沢 | これだけ知っていれば LPWA
WiredTigerを詳しく説明
WiredTigerを詳しく説明
チャットコミュニケーションの問題と心理的安全性の課題 #EOF2019
チャットコミュニケーションの問題と心理的安全性の課題 #EOF2019
技術系文書作成のコツ
技術系文書作成のコツ
ウェブ・セキュリティ基礎試験(徳丸基礎試験)の模擬試験問題
ウェブ・セキュリティ基礎試験(徳丸基礎試験)の模擬試験問題
Reality introduction (feb 2021)
Reality introduction (feb 2021)
webエンジニアのためのはじめてのredis
webエンジニアのためのはじめてのredis
正しいものを正しくつくる
正しいものを正しくつくる
Snowflake Architecture and Performance(db tech showcase Tokyo 2018)
Snowflake Architecture and Performance(db tech showcase Tokyo 2018)
ソフトウェア設計の学び方を考える
ソフトウェア設計の学び方を考える
OSSで出来るインシデント管理とサービス資産管理及び構成管理の自動化
OSSで出来るインシデント管理とサービス資産管理及び構成管理の自動化
Python におけるドメイン駆動設計(戦術面)の勘どころ
Python におけるドメイン駆動設計(戦術面)の勘どころ
Redisの特徴と活用方法について
Redisの特徴と活用方法について
IT エンジニアのための 流し読み Windows - Microsoft Defender Exploit Guard
IT エンジニアのための 流し読み Windows - Microsoft Defender Exploit Guard
Private Recommender Systems: How Can Users Build Their Own Fair Recommender S...
Private Recommender Systems: How Can Users Build Their Own Fair Recommender S...
Azure IoT/AI最前線
Azure IoT/AI最前線
Mongo dbを知ろう
Mongo dbを知ろう
Google Cloud Platform で実現するプロダクションレディ マイクロサービス
Google Cloud Platform で実現するプロダクションレディ マイクロサービス
Destacado
開発の本質:チケット数を1/100にする方法
開発の本質:チケット数を1/100にする方法
Takahiro Kubo
TISにおける、研究開発のメソッド
TISにおける、研究開発のメソッド
Takahiro Kubo
画像認識モデルを作るための鉄板レシピ
画像認識モデルを作るための鉄板レシピ
Takahiro Kubo
TIS 戦略技術センター AI技術推進室紹介
TIS 戦略技術センター AI技術推進室紹介
Takahiro Kubo
kintone Cafe Japan 2016: kintone x 機械学習で実現する簡単名刺管理
kintone Cafe Japan 2016: kintone x 機械学習で実現する簡単名刺管理
Takahiro Kubo
文章を読み、理解する機能の獲得に向けて-Machine Comprehensionの研究動向-
文章を読み、理解する機能の獲得に向けて-Machine Comprehensionの研究動向-
Takahiro Kubo
人工知能と機械学習の違いって?
人工知能と機械学習の違いって?
Shuyo Nakatani
Tech-Circle #18 Pythonではじめる強化学習 OpenAI Gym 体験ハンズオン
Tech-Circle #18 Pythonではじめる強化学習 OpenAI Gym 体験ハンズオン
Takahiro Kubo
Pythonではじめる OpenAI Gymトレーニング
Pythonではじめる OpenAI Gymトレーニング
Takahiro Kubo
DevOpsとか言う前にAWSエンジニアに知ってほしいアプリケーションのこと
DevOpsとか言う前にAWSエンジニアに知ってほしいアプリケーションのこと
Terui Masashi
IT系メディアのライティング手法 紙からWebへ
IT系メディアのライティング手法 紙からWebへ
Nobuyori Takahashi
文章をもっと速くラクに効率よく量産するための4つのポイント
文章をもっと速くラクに効率よく量産するための4つのポイント
Etsuo Ohashi
機械学習技術の紹介
機械学習技術の紹介
Takahiro Kubo
マルチモーダル対話システムのスゝメ
マルチモーダル対話システムのスゝメ
Takahiro Kubo
文章を書く上で必要な考え方(基礎)
文章を書く上で必要な考え方(基礎)
Jo Hattori
Pythonで始めるWebアプリケーション開発
Pythonで始めるWebアプリケーション開発
Takahiro Kubo
対話破綻検出チャレンジ2016: NCMを用いた対話と破綻の同時学習
対話破綻検出チャレンジ2016: NCMを用いた対話と破綻の同時学習
Takahiro Kubo
文章のクオリティを上げる方法(井庭研レクチャーズ Vol.3)
文章のクオリティを上げる方法(井庭研レクチャーズ Vol.3)
Takashi Iba
「人工知能」をあなたのビジネスで活用するには
「人工知能」をあなたのビジネスで活用するには
Takahiro Kubo
Convolutional Neural Netwoks で自然言語処理をする
Convolutional Neural Netwoks で自然言語処理をする
Daiki Shimada
Destacado
(20)
開発の本質:チケット数を1/100にする方法
開発の本質:チケット数を1/100にする方法
TISにおける、研究開発のメソッド
TISにおける、研究開発のメソッド
画像認識モデルを作るための鉄板レシピ
画像認識モデルを作るための鉄板レシピ
TIS 戦略技術センター AI技術推進室紹介
TIS 戦略技術センター AI技術推進室紹介
kintone Cafe Japan 2016: kintone x 機械学習で実現する簡単名刺管理
kintone Cafe Japan 2016: kintone x 機械学習で実現する簡単名刺管理
文章を読み、理解する機能の獲得に向けて-Machine Comprehensionの研究動向-
文章を読み、理解する機能の獲得に向けて-Machine Comprehensionの研究動向-
人工知能と機械学習の違いって?
人工知能と機械学習の違いって?
Tech-Circle #18 Pythonではじめる強化学習 OpenAI Gym 体験ハンズオン
Tech-Circle #18 Pythonではじめる強化学習 OpenAI Gym 体験ハンズオン
Pythonではじめる OpenAI Gymトレーニング
Pythonではじめる OpenAI Gymトレーニング
DevOpsとか言う前にAWSエンジニアに知ってほしいアプリケーションのこと
DevOpsとか言う前にAWSエンジニアに知ってほしいアプリケーションのこと
IT系メディアのライティング手法 紙からWebへ
IT系メディアのライティング手法 紙からWebへ
文章をもっと速くラクに効率よく量産するための4つのポイント
文章をもっと速くラクに効率よく量産するための4つのポイント
機械学習技術の紹介
機械学習技術の紹介
マルチモーダル対話システムのスゝメ
マルチモーダル対話システムのスゝメ
文章を書く上で必要な考え方(基礎)
文章を書く上で必要な考え方(基礎)
Pythonで始めるWebアプリケーション開発
Pythonで始めるWebアプリケーション開発
対話破綻検出チャレンジ2016: NCMを用いた対話と破綻の同時学習
対話破綻検出チャレンジ2016: NCMを用いた対話と破綻の同時学習
文章のクオリティを上げる方法(井庭研レクチャーズ Vol.3)
文章のクオリティを上げる方法(井庭研レクチャーズ Vol.3)
「人工知能」をあなたのビジネスで活用するには
「人工知能」をあなたのビジネスで活用するには
Convolutional Neural Netwoks で自然言語処理をする
Convolutional Neural Netwoks で自然言語処理をする
Más de Takahiro Kubo
自然言語処理による企業の気候変動対策分析
自然言語処理による企業の気候変動対策分析
Takahiro Kubo
国際会計基準(IFRS)適用企業の財務評価方法
国際会計基準(IFRS)適用企業の財務評価方法
Takahiro Kubo
自然言語処理で新型コロナウィルスに立ち向かう
自然言語処理で新型コロナウィルスに立ち向かう
Takahiro Kubo
財務・非財務一体型の企業分析に向けて
財務・非財務一体型の企業分析に向けて
Takahiro Kubo
自然言語処理で読み解く金融文書
自然言語処理で読み解く金融文書
Takahiro Kubo
arXivTimes Review: 2019年前半で印象に残った論文を振り返る
arXivTimes Review: 2019年前半で印象に残った論文を振り返る
Takahiro Kubo
ESG評価を支える自然言語処理基盤の構築
ESG評価を支える自然言語処理基盤の構築
Takahiro Kubo
Expressing Visual Relationships via Language: 自然言語による画像編集を目指して
Expressing Visual Relationships via Language: 自然言語による画像編集を目指して
Takahiro Kubo
Reinforcement Learning Inside Business
Reinforcement Learning Inside Business
Takahiro Kubo
あるべきESG投資の評価に向けた、自然言語処理の活用
あるべきESG投資の評価に向けた、自然言語処理の活用
Takahiro Kubo
nlpaper.challenge NLP/CV交流勉強会 画像認識 7章
nlpaper.challenge NLP/CV交流勉強会 画像認識 7章
Takahiro Kubo
Curiosity may drives your output routine.
Curiosity may drives your output routine.
Takahiro Kubo
モデルではなく、データセットを蒸留する
モデルではなく、データセットを蒸留する
Takahiro Kubo
EMNLP2018 Overview
EMNLP2018 Overview
Takahiro Kubo
2018年12月4日までに『呪術廻戦』を読む理由
2018年12月4日までに『呪術廻戦』を読む理由
Takahiro Kubo
Graph Attention Network
Graph Attention Network
Takahiro Kubo
ACL2018の歩き方
ACL2018の歩き方
Takahiro Kubo
機械学習で泣かないためのコード設計 2018
機械学習で泣かないためのコード設計 2018
Takahiro Kubo
TISにおける、研究開発の方針とメソッド 2018
TISにおける、研究開発の方針とメソッド 2018
Takahiro Kubo
感情の出どころを探る、一歩進んだ感情解析
感情の出どころを探る、一歩進んだ感情解析
Takahiro Kubo
Más de Takahiro Kubo
(20)
自然言語処理による企業の気候変動対策分析
自然言語処理による企業の気候変動対策分析
国際会計基準(IFRS)適用企業の財務評価方法
国際会計基準(IFRS)適用企業の財務評価方法
自然言語処理で新型コロナウィルスに立ち向かう
自然言語処理で新型コロナウィルスに立ち向かう
財務・非財務一体型の企業分析に向けて
財務・非財務一体型の企業分析に向けて
自然言語処理で読み解く金融文書
自然言語処理で読み解く金融文書
arXivTimes Review: 2019年前半で印象に残った論文を振り返る
arXivTimes Review: 2019年前半で印象に残った論文を振り返る
ESG評価を支える自然言語処理基盤の構築
ESG評価を支える自然言語処理基盤の構築
Expressing Visual Relationships via Language: 自然言語による画像編集を目指して
Expressing Visual Relationships via Language: 自然言語による画像編集を目指して
Reinforcement Learning Inside Business
Reinforcement Learning Inside Business
あるべきESG投資の評価に向けた、自然言語処理の活用
あるべきESG投資の評価に向けた、自然言語処理の活用
nlpaper.challenge NLP/CV交流勉強会 画像認識 7章
nlpaper.challenge NLP/CV交流勉強会 画像認識 7章
Curiosity may drives your output routine.
Curiosity may drives your output routine.
モデルではなく、データセットを蒸留する
モデルではなく、データセットを蒸留する
EMNLP2018 Overview
EMNLP2018 Overview
2018年12月4日までに『呪術廻戦』を読む理由
2018年12月4日までに『呪術廻戦』を読む理由
Graph Attention Network
Graph Attention Network
ACL2018の歩き方
ACL2018の歩き方
機械学習で泣かないためのコード設計 2018
機械学習で泣かないためのコード設計 2018
TISにおける、研究開発の方針とメソッド 2018
TISにおける、研究開発の方針とメソッド 2018
感情の出どころを探る、一歩進んだ感情解析
感情の出どころを探る、一歩進んだ感情解析
技術文書を書く際の、心技体
1.
技 術 文
書 を 書 く 際 の 、 心 技 体 @icoxfog417
2.
1 技術文書の定義 技術文書の心技体 心:記事を書くときの心構え 体:技術文書の構成要素とその目的 技:各要素の書き方 演習問題
3.
2 今から解説を行う技術文書とは、何かしらの技術的な知識を、 「他者 へ伝達することを目的として」書かれた文書とします。 そうした意味では、本稿で扱う技術文書の書き出しは「他者に伝えた い」というモチベーションから始まります。 本文書は、その思いを最大限活かすために書かれた「技術文書」です。
4.
3 技術文書における「心技体」とは なんなのか、説明します。 序 体 心 技 技術文書を書く際に、意識してお くべき点について解説します。 技術文書の基本的な構成について 解説します。 技術文書を書く「技術」について、 具体例を交えながら解説します。
5.
4 ここからは、技術文書を書くための手法について、心・技・体に分けて 解説をしていこうと思います(※構成の都合上、解説の順番は心・体・ 技になります)。 具体的には、以下の点について解説をしていきます。 心:技術文書を書く上で、意識しておくべきこと 体:技術文書の構成 技:読んでもらうためのテクニック
6.
心
7.
6 技術文書を読むという行為を通じて、読み手は新しい知識を獲得します。 それは一つの「体験」と捉えることができ、音楽を聴く、映画を見ると いった行為と何ら変わりません。新しい知識の獲得は、人間にとって、 技術者にとってはなおさら、本来的に魅力的な体験だからです。 この過程をどうデザインするのか、という観点を持つと文章の書き方は かなり変わってくると思います。大げさに言えば、作曲家や映画監督の 視点を入れてみるということです。 読み手の「知識獲得の体験」をデザインする
8.
体
9.
8 技術文書の構成は、目的別に大きく以下の3つに分けることができます。 タイトル:文章を開いてもらう(クリックしてもらう) 前文
:文章を読んでもらう 本文 :技術を理解してもらう 読み手の目線から言えば、タイトルで文章を開くか判断し、前文で読み 続けるか決め、そこから初めて本文にふれるということです。
10.
9 勝負の「第一印象」 特にタイトル・前文は以下のよう に「第一印象」を決める重要な要 素になります。 一覧に表示されるテキスト 記事を開いた際表示される範囲
SNSなどで共有される際に表示 されるサムネイル・テキスト (20~50文字)
11.
技
12.
11 文書を読んでもらうには、人のモチベーションを喚起する必要がありま す。この「人のモチベーション」には以下7種類の要因があります。こ れらを理解することは、魅力的な体験の演出に役立ちます。 帰属意識 習慣 物語の力 アメとムチ 本能 熟達願望 心の錯覚 次のスライドで簡単に紹介しますが、詳 細は長くなるので、興味がある方は↓を 読んでみてください。 説得とヤル気の科学 ―最新心理学研究が解き明かす 「その気にさせる」メカニズム
13.
12 帰属意識 習慣 物語の力 アメとムチ 本能 熟達願望 心の錯覚 自分と同じ境遇と感じる人に言われると行動しやすい。 いつも行っていることに関連することは行いやすい。 自分自身の性格や希望像に沿うことは行いやすい。 自分が既に知っていることや明確なことだと行いやすい。 報酬がもらえるなら行動しやすい。 危機感や希少性があることについては行動しやすい。 挑戦し甲斐があり、成長が実感できるものは行動しやすい。
14.
13 これらのモチベーションを喚起する要素を踏まえた上で、各パートを書 く際にこれらをどのように活かしていくのかについて、見ていきます。 タイトル 前文
本文
15.
14 タイトルは文章を開いてもらうための最も重要なパーツになります。モ チベーションを喚起する要素を駆使し、「読みたくなるような」タイト ルを付けます。 帰属意識:数式で挫折した人たちに贈る、初歩からの機械学習 物語の力:フルスタックエンジニアになるための、基礎知識総ざらい
本能:2017年をサヴァイブするためのJavaScript開発環境 熟達願望:関数型プログラミングの鬼門、モナドにチャレンジ 心の錯覚:TensorFlowを算数で理解する
16.
15 タイトルは重要であるぶん、過激な表現になりがちです。しかし、技術 文書は他者にクリックさせることが目的ではなく、技術を伝えることが 目的です。 基本的に、きちんとした内容であれば成果はしっかりついてきます。読 み手に、またあなた自身が伝える技術に誠実にタイトルを付けてくださ い。そこに、少しの遊び心をいれるというのが良い配分と思います。 誠実さと遊び心
17.
前文は記事を「読み続けるか」判断するための重要なパートになります。 どれだけ良いタイトルを付けても、前文が悪ければ文書は閉じられてし まいます。 前文で特に重要となるモチベーションの要素は、 以下の3つです。 まず「現状の状態」を共有し(帰属意識)、そこから抜け出すための「獲得 し甲斐のある知識」を提示する(熟達願望)。そして「それを獲得するス トーリー」を明示する(物語の力)、というのが基本的な流れになります。 熟達願望 物語の力 16 帰属意識
18.
17 TensorFlow。挑戦したいけれども、そもそも機械学習も知らない自分に は難しい・・・と感じる方も多いのではないかと思います。 そこで、本記事では機械学習の仕組み、そしてTensorFlowでの実装方法 を、算数程度の簡単な演算をベースに解説していきたいと思います。 熟達願望 物語の力帰属意識
19.
18 TensorFlow。挑戦したいけれども、そもそも機械学習も知らない自分に は難しい・・・と感じる方も多いのではないかと思います。 そこで、本記事では機械学習の仕組み、そしてTensorFlowでの実装方法 を、算数程度の簡単な演算をベースに解説していきたいと思います。 熟達願望 物語の力帰属意識
20.
19 TensorFlow。挑戦したいけれども、そもそも機械学習も知らない自分に は難しい・・・と感じる方も多いのではないかと思います。 そこで、本記事では機械学習の仕組み、そしてTensorFlowでの実装方法 を、算数程度の簡単な演算をベースに解説していきたいと思います。 熟達願望 物語の力帰属意識
21.
20 本文に記載される技術情報は、読み手に取って未知の事柄になります。 この「未知の技術の習得」を楽しんでもらうのが、「知識獲得の体験」 をデザインするということになります。 そのために重要なのが、まず地図(全体像)を明示するということです。 見知らぬ土地に行く際はまず地図を買うように、明確な道筋が見えると 不快感がなくなり期待感が醸成されます。 これを行った上で、読み進めてもらうために構成を工夫します。 読み手の頭の中に地図を作る
22.
21 読み進めてもらう、つまり読むモチベーションを喚起するのに使える要 素は以下の3点です。 読み手の体験を想像する 熟達願望 アメとムチ心の錯覚 読み手が既に理解しているであろうことに例えるのは、理解の促進に役 立ちます(心の錯覚)。そして 「読む→理解!」という成功体験が都度得 られる単位に解説を分けることで、読む意欲を保つことができます(熟 達願望/アメとムチ)。
23.
22 Reactで作成するアプリケーションの構造は、古き良き(?)ピラミッド型の 組織にとてもよく似ています。React社会において組織の構成員は Componentと呼ばれ、データを受け取るとそれを処理します。このデータ は必ず上位の組織から流れてくることになっており、どれだけ横にパス したほうが効率が良くても、必ず上を通してデータを伝達します。効率 のよさよりも、規律を重んじるのがReact Wayというわけです。 心の錯覚 全体像の提示
24.
23 本記事は、理解・実践・応用という3ステップでこのReact社会で生きる 術を学んでいきます。 ・理解:React社会の掟を、実際のコードも交え理解します ・実践:簡単なToDoアプリを作成することで、その扱い方を理解します ・応用:現場で導入する際に必要となる追加知識について、理解します では、はじめていきましょう! アメとムチ熟達願望
25.
実践
26.
25 以下に、書きやすそうなテーマをいくつか用意してみました。実践編と して、これらをテーマにタイトルと前文、本文の構成までを考えて、実 際に書き出してみてください。 機械学習 フロントエンド界隈の技術
職場で実践しているノウハウ(テストやCIなど) 好きなエディタやツール、言語の普及 最近の失敗や障害から学んだ知見
27.
26 Have a Good
Writing!
Descargar ahora