Submit Search
Upload
社内のマニュアルをSphinxで作ってみた
•
3 likes
•
6,209 views
Iosif Takakura
Follow
社内のマニュアルをSphinxで作ってみたら見事に技術的負債になった話。
Read less
Read more
Technology
Report
Share
Report
Share
1 of 22
Download now
Download to read offline
Recommended
なぜコンピュータを学ばなければならないのか 21世紀の君主論
なぜコンピュータを学ばなければならないのか 21世紀の君主論
Tokoroten Nakayama
事業の進展とデータマネジメント体制の進歩(+プレトタイプの話)
事業の進展とデータマネジメント体制の進歩(+プレトタイプの話)
Tokoroten Nakayama
研究の基本ツール
研究の基本ツール
由来 藤原
先端技術とメディア表現1 #FTMA15
先端技術とメディア表現1 #FTMA15
Yoichi Ochiai
ラボラトリーオートメーションのためのソフトウェア思想教育(非プログラマ―が知っておくべきプログラミングの本質)
ラボラトリーオートメーションのためのソフトウェア思想教育(非プログラマ―が知っておくべきプログラミングの本質)
Tokoroten Nakayama
IT系エンジニアのためのプレゼンテーション入門
IT系エンジニアのためのプレゼンテーション入門
Masahito Zembutsu
エンジニアの個人ブランディングと技術組織
エンジニアの個人ブランディングと技術組織
Takafumi ONAKA
Surveyから始まる研究者への道 - Stand on the shoulders of giants -
Surveyから始まる研究者への道 - Stand on the shoulders of giants -
諒介 荒木
Recommended
なぜコンピュータを学ばなければならないのか 21世紀の君主論
なぜコンピュータを学ばなければならないのか 21世紀の君主論
Tokoroten Nakayama
事業の進展とデータマネジメント体制の進歩(+プレトタイプの話)
事業の進展とデータマネジメント体制の進歩(+プレトタイプの話)
Tokoroten Nakayama
研究の基本ツール
研究の基本ツール
由来 藤原
先端技術とメディア表現1 #FTMA15
先端技術とメディア表現1 #FTMA15
Yoichi Ochiai
ラボラトリーオートメーションのためのソフトウェア思想教育(非プログラマ―が知っておくべきプログラミングの本質)
ラボラトリーオートメーションのためのソフトウェア思想教育(非プログラマ―が知っておくべきプログラミングの本質)
Tokoroten Nakayama
IT系エンジニアのためのプレゼンテーション入門
IT系エンジニアのためのプレゼンテーション入門
Masahito Zembutsu
エンジニアの個人ブランディングと技術組織
エンジニアの個人ブランディングと技術組織
Takafumi ONAKA
Surveyから始まる研究者への道 - Stand on the shoulders of giants -
Surveyから始まる研究者への道 - Stand on the shoulders of giants -
諒介 荒木
第1回ROS勉強会発表資料 ROS+Gazeboではじめるロボットシミュレーション
第1回ROS勉強会発表資料 ROS+Gazeboではじめるロボットシミュレーション
akio19937
優れた研究論文の書き方―7つの提案
優れた研究論文の書き方―7つの提案
Masanori Kado
PHPからgoへの移行で分かったこと
PHPからgoへの移行で分かったこと
gree_tech
CV分野におけるサーベイ方法
CV分野におけるサーベイ方法
Hirokatsu Kataoka
営業さんまで、社員全員がSQLを使う 「越境型組織」 ができるまでの3+1のポイント | リブセンス
営業さんまで、社員全員がSQLを使う 「越境型組織」 ができるまでの3+1のポイント | リブセンス
Livesense Inc.
基礎線形代数講座
基礎線形代数講座
SEGADevTech
5分で出来る!イケてるconfluenceページ
5分で出来る!イケてるconfluenceページ
CLARA ONLINE, Inc.
Pythonによる黒魔術入門
Pythonによる黒魔術入門
大樹 小倉
機械学習モデルの判断根拠の説明
機械学習モデルの判断根拠の説明
Satoshi Hara
ナレッジグラフ入門
ナレッジグラフ入門
KnowledgeGraph
イミュータブルデータモデルの極意
イミュータブルデータモデルの極意
Yoshitaka Kawashima
なぜ、いま リレーショナルモデルなのか(理論から学ぶデータベース実践入門読書会スペシャル)
なぜ、いま リレーショナルモデルなのか(理論から学ぶデータベース実践入門読書会スペシャル)
Mikiya Okuno
Redisの特徴と活用方法について
Redisの特徴と活用方法について
Yuji Otani
Ml system in_python
Ml system in_python
yusuke shibui
「UXデザインとは」からはじめる「本流」のUXデザインはじめの一歩 | UXデザイン基礎セミナー 第1回
「UXデザインとは」からはじめる「本流」のUXデザインはじめの一歩 | UXデザイン基礎セミナー 第1回
Yoshiki Hayama
マッチングサービスにおけるKPIの話
マッチングサービスにおけるKPIの話
cyberagent
研究分野をサーベイする
研究分野をサーベイする
Takayuki Itoh
イミュータブルデータモデル(世代編)
イミュータブルデータモデル(世代編)
Yoshitaka Kawashima
Rustに触れて私のPythonはどう変わったか
Rustに触れて私のPythonはどう変わったか
ShunsukeNakamura17
エキスパートPythonプログラミング改訂3版の読みどころ
エキスパートPythonプログラミング改訂3版の読みどころ
Takayuki Shimizukawa
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Takeshi Komiya
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Takeshi Komiya
More Related Content
What's hot
第1回ROS勉強会発表資料 ROS+Gazeboではじめるロボットシミュレーション
第1回ROS勉強会発表資料 ROS+Gazeboではじめるロボットシミュレーション
akio19937
優れた研究論文の書き方―7つの提案
優れた研究論文の書き方―7つの提案
Masanori Kado
PHPからgoへの移行で分かったこと
PHPからgoへの移行で分かったこと
gree_tech
CV分野におけるサーベイ方法
CV分野におけるサーベイ方法
Hirokatsu Kataoka
営業さんまで、社員全員がSQLを使う 「越境型組織」 ができるまでの3+1のポイント | リブセンス
営業さんまで、社員全員がSQLを使う 「越境型組織」 ができるまでの3+1のポイント | リブセンス
Livesense Inc.
基礎線形代数講座
基礎線形代数講座
SEGADevTech
5分で出来る!イケてるconfluenceページ
5分で出来る!イケてるconfluenceページ
CLARA ONLINE, Inc.
Pythonによる黒魔術入門
Pythonによる黒魔術入門
大樹 小倉
機械学習モデルの判断根拠の説明
機械学習モデルの判断根拠の説明
Satoshi Hara
ナレッジグラフ入門
ナレッジグラフ入門
KnowledgeGraph
イミュータブルデータモデルの極意
イミュータブルデータモデルの極意
Yoshitaka Kawashima
なぜ、いま リレーショナルモデルなのか(理論から学ぶデータベース実践入門読書会スペシャル)
なぜ、いま リレーショナルモデルなのか(理論から学ぶデータベース実践入門読書会スペシャル)
Mikiya Okuno
Redisの特徴と活用方法について
Redisの特徴と活用方法について
Yuji Otani
Ml system in_python
Ml system in_python
yusuke shibui
「UXデザインとは」からはじめる「本流」のUXデザインはじめの一歩 | UXデザイン基礎セミナー 第1回
「UXデザインとは」からはじめる「本流」のUXデザインはじめの一歩 | UXデザイン基礎セミナー 第1回
Yoshiki Hayama
マッチングサービスにおけるKPIの話
マッチングサービスにおけるKPIの話
cyberagent
研究分野をサーベイする
研究分野をサーベイする
Takayuki Itoh
イミュータブルデータモデル(世代編)
イミュータブルデータモデル(世代編)
Yoshitaka Kawashima
Rustに触れて私のPythonはどう変わったか
Rustに触れて私のPythonはどう変わったか
ShunsukeNakamura17
エキスパートPythonプログラミング改訂3版の読みどころ
エキスパートPythonプログラミング改訂3版の読みどころ
Takayuki Shimizukawa
What's hot
(20)
第1回ROS勉強会発表資料 ROS+Gazeboではじめるロボットシミュレーション
第1回ROS勉強会発表資料 ROS+Gazeboではじめるロボットシミュレーション
優れた研究論文の書き方―7つの提案
優れた研究論文の書き方―7つの提案
PHPからgoへの移行で分かったこと
PHPからgoへの移行で分かったこと
CV分野におけるサーベイ方法
CV分野におけるサーベイ方法
営業さんまで、社員全員がSQLを使う 「越境型組織」 ができるまでの3+1のポイント | リブセンス
営業さんまで、社員全員がSQLを使う 「越境型組織」 ができるまでの3+1のポイント | リブセンス
基礎線形代数講座
基礎線形代数講座
5分で出来る!イケてるconfluenceページ
5分で出来る!イケてるconfluenceページ
Pythonによる黒魔術入門
Pythonによる黒魔術入門
機械学習モデルの判断根拠の説明
機械学習モデルの判断根拠の説明
ナレッジグラフ入門
ナレッジグラフ入門
イミュータブルデータモデルの極意
イミュータブルデータモデルの極意
なぜ、いま リレーショナルモデルなのか(理論から学ぶデータベース実践入門読書会スペシャル)
なぜ、いま リレーショナルモデルなのか(理論から学ぶデータベース実践入門読書会スペシャル)
Redisの特徴と活用方法について
Redisの特徴と活用方法について
Ml system in_python
Ml system in_python
「UXデザインとは」からはじめる「本流」のUXデザインはじめの一歩 | UXデザイン基礎セミナー 第1回
「UXデザインとは」からはじめる「本流」のUXデザインはじめの一歩 | UXデザイン基礎セミナー 第1回
マッチングサービスにおけるKPIの話
マッチングサービスにおけるKPIの話
研究分野をサーベイする
研究分野をサーベイする
イミュータブルデータモデル(世代編)
イミュータブルデータモデル(世代編)
Rustに触れて私のPythonはどう変わったか
Rustに触れて私のPythonはどう変わったか
エキスパートPythonプログラミング改訂3版の読みどころ
エキスパートPythonプログラミング改訂3版の読みどころ
Similar to 社内のマニュアルをSphinxで作ってみた
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Takeshi Komiya
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Takeshi Komiya
Sphinxでまとめる多言語環境APIドキュメント
Sphinxでまとめる多言語環境APIドキュメント
Iosif Takakura
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjp
Takeshi Komiya
Flex入門
Flex入門
Shinjiro Watanabe
Sphinxの使い方事例
Sphinxの使い方事例
Go Yamada
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
Yoshiki Shibukawa
Sphinxの環境構築が再現できない問題をDockerで解決してみた
Sphinxの環境構築が再現できない問題をDockerで解決してみた
Study Group by SciencePark Corp.
React+fluxを導入した話
React+fluxを導入した話
Yuki Ishikawa
ソニーでElectronアプリをリリースしてみた
ソニーでElectronアプリをリリースしてみた
Yasuharu Seki
scala未経験者がフルペアプロで新規事業の開発をしている話
scala未経験者がフルペアプロで新規事業の開発をしている話
hayato iida
とある Perl Monger の働き方
とある Perl Monger の働き方
Yusuke Wada
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
Study Group by SciencePark Corp.
ひとりsphinx
ひとりsphinx
(^-^) togakushi
Zappa で Serverless CMS を作ってみる
Zappa で Serverless CMS を作ってみる
Iosif Takakura
Developers Summit 2014 「Play2/Scalaでドメイン駆動設計を利用した大規模Webアプリケーションのスクラム開発の勘所」
Developers Summit 2014 「Play2/Scalaでドメイン駆動設計を利用した大規模Webアプリケーションのスクラム開発の勘所」
Yoshimura Soichiro
YAPC::Hokkaido 2016 「普段使い言語環境」更新によるスキルリセットサバイバルガイド
YAPC::Hokkaido 2016 「普段使い言語環境」更新によるスキルリセットサバイバルガイド
keroyonn
SeeedJP User Group 情報交換会発表資料
SeeedJP User Group 情報交換会発表資料
Shigeo Ueda
Nervesが開拓する「ElixirでIoT」の新世界
Nervesが開拓する「ElixirでIoT」の新世界
Hideki Takase
Sphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメント
Go Yamada
Similar to 社内のマニュアルをSphinxで作ってみた
(20)
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinxでまとめる多言語環境APIドキュメント
Sphinxでまとめる多言語環境APIドキュメント
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjp
Flex入門
Flex入門
Sphinxの使い方事例
Sphinxの使い方事例
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
Sphinxの環境構築が再現できない問題をDockerで解決してみた
Sphinxの環境構築が再現できない問題をDockerで解決してみた
React+fluxを導入した話
React+fluxを導入した話
ソニーでElectronアプリをリリースしてみた
ソニーでElectronアプリをリリースしてみた
scala未経験者がフルペアプロで新規事業の開発をしている話
scala未経験者がフルペアプロで新規事業の開発をしている話
とある Perl Monger の働き方
とある Perl Monger の働き方
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
ひとりsphinx
ひとりsphinx
Zappa で Serverless CMS を作ってみる
Zappa で Serverless CMS を作ってみる
Developers Summit 2014 「Play2/Scalaでドメイン駆動設計を利用した大規模Webアプリケーションのスクラム開発の勘所」
Developers Summit 2014 「Play2/Scalaでドメイン駆動設計を利用した大規模Webアプリケーションのスクラム開発の勘所」
YAPC::Hokkaido 2016 「普段使い言語環境」更新によるスキルリセットサバイバルガイド
YAPC::Hokkaido 2016 「普段使い言語環境」更新によるスキルリセットサバイバルガイド
SeeedJP User Group 情報交換会発表資料
SeeedJP User Group 情報交換会発表資料
Nervesが開拓する「ElixirでIoT」の新世界
Nervesが開拓する「ElixirでIoT」の新世界
Sphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメント
More from Iosif Takakura
取り込んだネガ画像の色を変換する Python スクリプトを書いてみた
取り込んだネガ画像の色を変換する Python スクリプトを書いてみた
Iosif Takakura
Marp for VS Code で作る PowerPoint スライド
Marp for VS Code で作る PowerPoint スライド
Iosif Takakura
scikit-image でフィルムスキャナで取り込んだネガ画像をポジ化する
scikit-image でフィルムスキャナで取り込んだネガ画像をポジ化する
Iosif Takakura
Django 製 CMS Wagtail で Blog を作ってみる
Django 製 CMS Wagtail で Blog を作ってみる
Iosif Takakura
Django と Wagtail で作る Headless CMS
Django と Wagtail で作る Headless CMS
Iosif Takakura
DocFXで脱Excel方眼紙!
DocFXで脱Excel方眼紙!
Iosif Takakura
技術的負債との戦い方
技術的負債との戦い方
Iosif Takakura
C#初心者がxamarinに手を出してみた
C#初心者がxamarinに手を出してみた
Iosif Takakura
Sphinxで同人誌を書いてみた
Sphinxで同人誌を書いてみた
Iosif Takakura
ようこそ先輩 - 2014年8月2日
ようこそ先輩 - 2014年8月2日
Iosif Takakura
Osuncが終わったら帰りは警察署に行きましょう
Osuncが終わったら帰りは警察署に行きましょう
Iosif Takakura
More from Iosif Takakura
(11)
取り込んだネガ画像の色を変換する Python スクリプトを書いてみた
取り込んだネガ画像の色を変換する Python スクリプトを書いてみた
Marp for VS Code で作る PowerPoint スライド
Marp for VS Code で作る PowerPoint スライド
scikit-image でフィルムスキャナで取り込んだネガ画像をポジ化する
scikit-image でフィルムスキャナで取り込んだネガ画像をポジ化する
Django 製 CMS Wagtail で Blog を作ってみる
Django 製 CMS Wagtail で Blog を作ってみる
Django と Wagtail で作る Headless CMS
Django と Wagtail で作る Headless CMS
DocFXで脱Excel方眼紙!
DocFXで脱Excel方眼紙!
技術的負債との戦い方
技術的負債との戦い方
C#初心者がxamarinに手を出してみた
C#初心者がxamarinに手を出してみた
Sphinxで同人誌を書いてみた
Sphinxで同人誌を書いてみた
ようこそ先輩 - 2014年8月2日
ようこそ先輩 - 2014年8月2日
Osuncが終わったら帰りは警察署に行きましょう
Osuncが終わったら帰りは警察署に行きましょう
Recently uploaded
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
iPride Co., Ltd.
プレイマットのパターン生成支援ツール
プレイマットのパターン生成支援ツール
sugiuralab
Postman LT Fukuoka_Quick Prototype_By Daniel
Postman LT Fukuoka_Quick Prototype_By Daniel
danielhu54
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
Atomu Hidaka
プレイマットのパターン生成支援ツールの評価
プレイマットのパターン生成支援ツールの評価
sugiuralab
PHP-Conference-Odawara-2024-04-000000000
PHP-Conference-Odawara-2024-04-000000000
Shota Ito
20240412_HCCJP での Windows Server 2025 Active Directory
20240412_HCCJP での Windows Server 2025 Active Directory
osamut
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
iPride Co., Ltd.
Recently uploaded
(8)
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
プレイマットのパターン生成支援ツール
プレイマットのパターン生成支援ツール
Postman LT Fukuoka_Quick Prototype_By Daniel
Postman LT Fukuoka_Quick Prototype_By Daniel
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
プレイマットのパターン生成支援ツールの評価
プレイマットのパターン生成支援ツールの評価
PHP-Conference-Odawara-2024-04-000000000
PHP-Conference-Odawara-2024-04-000000000
20240412_HCCJP での Windows Server 2025 Active Directory
20240412_HCCJP での Windows Server 2025 Active Directory
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
社内のマニュアルをSphinxで作ってみた
1.
1 社内の マニュアルを Sphinxで 作ってみたIosif Takakura (@huideyeren) 1
2.
2 はじめに
3.
3 自己紹介 名前:Iosif Takakura 所属:とあるアパレル系の特例子会社 職種:一応エンジニアになりました レガシーシステムとExcel方眼紙のお守りをしてます 主な技術:C#、JS、Ruby Pythonは学習中 興味のあること 機械学習 モバイルプログラミング ソーシャルネットワーク 発達障がい当事者
4.
4 Sphinxとのかかわり 1. すでに退社した某氏による紹介 2. 同人誌を書くのに使ってみた ただし新刊はRe:VIEWに移行 3.
社内ドキュメントをSphinxで作ってみた 今日はこの話を予定 どう書くか、といった話は少なめ むしろ技術的負債メインだよ
5.
5 導入編
6.
6 Sphinxで書いたマニュアル 業務マニュアル 技術解説文書
7.
7 業務マニュアルが必要になる背景 HP作成業務でドキュメントが必要だった 1. HP作成にMiddlemanを使った 2. Middleman扱える人の退社が相次ぐ 3.
最低限更新ができるレベルのマニュアルがほしい 4. Sphinxで書いた Excel方眼紙大嫌い 2次元的な表現(図表・グラフなど)が苦手 レイアウトを決めながら文書を書けないタイプ 文章はそこまで苦手じゃない ただし長くなる傾向あり Excelは単一ファイルなので同時編集できない Sphinxなら分担して書きやすい
8.
8 技術解説文書を残した理由 中身を理解していじれる人が1人になってしまった 想定読者が「この通りに操作すれば更新できる」レベル だけどこんなんじゃぜんぜんたりない 技術とともにエンジニアとしての心構えを伝えたかった
9.
9 社内環境 勝手にソフトウェアを入れられる環境にない ただし、社内ネットワークの管理外ならOK Macは社内ネットワーク管理外 親会社IT部門の管轄下 技術的にはWindowsメイン 結局、独断で導入した 様々な技術レベルの人が混在 社内にはWordやExcelしかできない人も コマンドライン使えるのはごく少数 Excel方眼紙が跳梁跋扈 勘弁してください コスト管理はしっかりしている ただし、余計な工数は割きづらい
10.
10 なぜ業務マニュアルにSphinxを使ったか HTMLで見やすいドキュメントができる 図表が苦手な私にとって助かる でもスクリーンショットは必要 レイアウトとコンテンツを分離できるため MacはIT部門の管轄外 独断で環境を整える場合Macしか選択肢がない
11.
11 文書の作成 内部の構成は分けられるように includeを多用 toctreeで項目ごとに書いていく apidoc的なものは一切使ってない まあRubyだし…… 連携できる何かはあるのだろうけど知らなかった Pandocを使ってMarkdownから変換 素のreST教えるよりよいかな、と これからのスキルにMarkdownは必須、ということで 余計に書きすぎる癖が炸裂 内容の校正に時間がかかってしまった
12.
12 開発環境 macOS Python3 Atom Pandoc MacTeX CIとかは使わない
13.
13 執筆者 私 Aさん 2016年度の新人 ITスキルはある方 Java経験あり ただしSphinxは初めて UNIX系経験も多いとは言えない CUIに慣れていない
14.
14 完成後の運用編
15.
15 チームメンバーの変遷 1. 社内でソフトウェア開発に取り組むため私がチームを抜ける このときAさんに内部の詳細まで教えきれなかった 2. Aさんがさらに新人Bさんに教える 3.
そのAさんも開発案件に専従になる 4. Bさんが中心となってプロジェクトの保守を行っている 5. 現在、Bさんは新人Cさんにプロジェクトのことを教えている ドキュメントの不備が山のように見つかる 6. 別案件に忙殺されて私はドキュメントをメンテナンスできない
16.
16 ドキュメントのメンテナンス メンテナンスには手間がかかっていた わざわざMacに行くのが大変 reSTやMarkdownは学習コストがかかる Sphinx本なんてあるわけない 上司「なぜExcelやパワポで作らないの?」 Excelやパワポなら一応誰でも使える うまく反論できなかった 余計に書く癖がどんどん文書量を増やしてしまう ドキュメントのダイエットが必要 結果的にメンテナンスコストが増大 学習コストに割ける工数がなくなってしまった
17.
17 メンテナンスコストがかかると 1. メンテナンスされなくなる 2. 現実と内容の乖離 3.
修正の仕方がわからない 4. 放置されて技術的負債に…… 5. 枯れた技術でリプレース! 実際、ドキュメントは素のHTML で書き直されつつあります……
18.
18 ふりかえり
19.
19 教訓 独断での技術の導入はうまくいかない事が多い 組織がボトムアップ的改善を受け入れる余地がないと厳しい コストや周りの人の技術レベルなども考える必要がある 理解の難しい技術はオーパーツ化し、技術的負債になりやすい 最悪、ドキュメント自体が技術的負債になる 中心メンバーが抜けた後の運用も考える必要がある 特に、知識や技術の伝授をしっかりと コストについて考えることも忘れずに 楽に書けても学習コストが高いと釣り合わない それ故に誰でも使えるExcelなどが選択されやすい
20.
20 技術的負債とどう向き合うか 1. わかりやすい技術・構造を選択する 技術レベルに合わない技術は爆死しやすい かといって枯れすぎた技術を選んでも爆死する 2. 周りの人やマネージャー、経営層に説明できるようにする ここをうまくやらないと導入はうまくいかない マネージャーや経営層には数字で説得できる必要がある 特に、工数やコストは非常に重要 さらに、顧客にも説明できるとなおよい 3.
共通の認識を持てるように技術・知識を社内で広める 教え方を常に磨く必要がある 4. 共通認識ができたら技術的負債の解消に向けて動く 個人的には技術的負債と向き合う時期を作りたい そのためには常にコミュニケーションする事を忘れずに。
21.
21 メンテされやすいドキュメントの作り方 1. 「何で作るか」にこだわってはいけない ただし、誰でも編集できることは大事 ドキュメント作成者のスキルセットを考えよう 2. 必要最低限のドキュメントだけ作る 3.
定期的にメンテナンスする機会を設ける 4. コミュニケーション、大事! 積極的にコミュニケーションしよう 5. コスト意識を忘れずに その中には学習コストも含まれる
22.
22 おしまい ご清聴ありがとうございました
Download now