ドキュメント作成
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
|
ログイン
] [
Twitter
]
開始行:
→プロジェクト管理
→要件定義・基本設計
→詳細設計
→データベース設計 ←ER図についてはこちら
→アーキテクチャ←ADRについてはこちら
→PDF関連
#contents
*サブトピック [#l996e350]
-テスト関連ドキュメント作成
-ドキュメント作成ツール
-メモやナレッジを管理するツール
-Markdown記法
*文書作成・管理 [#wa512fce]
-[[ドキュメントを書かないことは「負債を生む」ということ #...
-[[LLMを味方につけた文章執筆術 - 執筆から校正までの実践的...
-[[技術ブログや登壇資料を秒で作るコツ伝授します - Speaker...
-[[ハンコを押す技術 (Pythonで画像生成) #Python - Qiita>ht...
-[[ドキュメントを書かないことは「負債を生む」ということ #...
-[[ドキュメント作成の手法について(図解作成) #ドキュメント...
-[[技術文書の長音記号どうする？「コンピューター」と「コン...
-[[設計ドキュメント腐る問題、Git管理で運用してみた結果 | ...
-[[データフロー図：情報の流れを視覚化し、ビジネスを理解す...
-[[エンジニア歴20数年の私が、設計書を書く際に心がけている...
-[[サーバーサイド仕様書をGitHubで管理してよかったこと - d...
-[[「エンジニアのためのドキュメントライティング」Docs for...
--[[【書籍】エンジニアのためのドキュメントライティング>ht...
-[[【NW構成図】は一周まわってエクセルで書けば良いのでは？...
-[[【書籍】ユーザーの問題解決とプロダクトの成功を導く エ...
-[[読みやすいドキュメントを書くために今日からできる7つの...
--1. 書くまえに、ドキュメントの目的を明確に定義する
--2. 書くまえに、筋道が立っているかを強く意識する
--3. 書くときに、読み手視点を強く意識する
--4. 書いたあとに、自身で推敲する
--5. ドキュメントの冒頭に要点をまとめる
--6. 一文一義・一文50文字以内で書く
--7. 表や図を用いる
-[[ユーザーなのか、ユーザなのか>https://zenn.dev/iwamasa/...
-[[技術文書の書き方 · GitHub>https://gist.github.com...
-[[わかりやすいシステム構成図の書き方 - Qiita>https://qii...
-[[データベースのテーブル定義の仕様書を自動生成しよう | C...
-[[最近、意味のない「にぎやかし図解」がやたらと多い気がす...
-[[開米のロジック図解入門・実践講座 – わかりやすく...
-[[Excel方眼紙がダメな２つの理由>http://watanabek.cocolog...
--まとめると、「Excel方眼紙」がダメな根源的な理由は２つあ...
--そういうわけで、この問題への対応状況には次の３段階があ...
---＜レベル０＞汎用ツールで仕様書を書いて、いちいちプログ...
---＜レベル１＞汎用ツールで仕様書を書いて、プログラミング...
---＜レベル２＞専用ツールで仕様書を書いて、プログラミング...
--参考記事：[[美文書作りには「方眼紙」シートを使う>http:/...
-[[ネットワーク図の書き方>http://d.hatena.ne.jp/elwoodblu...
-[[情報の構造化、してますか？>http://bizmakoto.jp/bizid/a...
-[[報告書の書き方>http://el.jibun.atmarkit.co.jp/yokoyama...
目標は何だったか
その目標は達成されたか
達成されたのは何が原因か
達成できなかったのは何が原因か
問題があった場合、解決のために自分はどんな努力をしたか
解決できなかった問題は、どうすれば解決できるか
そのためには何をしてほしいか
-仕様書の記述要領を決めるときに注意すべき一般的な項目
--大勢で仕様書を書くとき、平仄を合わせることが必要になり...
--スペースの表現方法。△を使うか、クォートで囲うか。
--改ページしたときにヘッダを再度表示するか。表で改ページ...
--注のつけ方。章ごとに注の本体を書くのか、ページごとに書...
--章立て、項目立ての項番体系。単項目になったときに番号を...
--既存の仕様書を修正で項番を削除するとき、詰めるのか、欠...
--ファイル名のつけ方のルール
--修正履歴の書き方。修正の理由も書くか。いつからバージョ...
--図表の番号、キャプションのつけかた
--Wordの場合、見出しにどんなスタイルをつけるか
--テンプレート(.dot)を使うか
--英数字は全角か、半角か
-[[読みやすい文章の極意は「修飾語」にあり>http://jibun.at...
-[[MSが長音付けルール変更、「ドライバ」を「ドライバー」に...
-[[発注者が理解しやすいシナリオの記述方法>http://www.nikk...
--システム化業務説明書とは，ある「システム化業務」の中で...
--基本，代替，例外の3つのシナリオを記述すること
--システム化業務のシナリオを利用者とシステムに分けて記述...
-[[ユーザと意思疎通が取れない外部設計書は危ない>http://it...
-[[議事録を書くときに意識すべきこと>http://d.hatena.ne.jp...
-[[議事録のプロ>http://itpro.nikkeibp.co.jp/article/COLUM...
--議事録には決まったことだけ書く
-[[どんな作業のマニュアルも３時間あれば作れる>http://d.ha...
--個人的には以下のようなマニュアル観は間違っていると思う。
---不完全なマニュアルを配られても困る
---マニュアルに書いてある通りにやって問題が起きるぐらいな...
---書いてある通りにやって問題が起きても作業者の責任ではな...
---マニュアルとは「書いてある通りに作業するためのもの」な...
---マニュアルがあると、それに頼り切って頭を使わなくなるの...
--どこが間違っているかというと、こう考える組織では永遠に...
-[[計画書をコピペしてはいけない>http://itpro.nikkeibp.co....
--「参考にする」ということと「コピペ」するということは違う
--ここはコピーしても大丈夫だろうと思っても，必ず一度自分...
-[[文章チェックを省略してはいけない>http://itpro.nikkeibp...
--「○○だけで（も）動く」と「○○でだけ動く」の違い
-[[仕様書の意義:http://dain.cocolog-nifty.com/myblog/2006...
--仕様書について人々が犯す最大の過ちは、公式のレビュー会...
*関連サイト [#n2961b30]
-[[はじめに | IT英語スタイルガイド>https://styleguide.pro...
-[[ドキュメント作成に役立つ「日本語スタイルガイド」の紹介...
-[[ラプラス取説研究所:http://laplace-lab.org/]]
*ツール [#e1f0a203]
→ドキュメント作成ツール ＜Draw.ioもこちら
*Help File [#c2427639]
-[[Sandcastle Help File Builder:http://www.codeproject.co...
-[[HTMLHelp:http://msdn.microsoft.com/library/default.asp...
終了行:
→プロジェクト管理
→要件定義・基本設計
→詳細設計
→データベース設計 ←ER図についてはこちら
→アーキテクチャ←ADRについてはこちら
→PDF関連
#contents
*サブトピック [#l996e350]
-テスト関連ドキュメント作成
-ドキュメント作成ツール
-メモやナレッジを管理するツール
-Markdown記法
*文書作成・管理 [#wa512fce]
-[[ドキュメントを書かないことは「負債を生む」ということ #...
-[[LLMを味方につけた文章執筆術 - 執筆から校正までの実践的...
-[[技術ブログや登壇資料を秒で作るコツ伝授します - Speaker...
-[[ハンコを押す技術 (Pythonで画像生成) #Python - Qiita>ht...
-[[ドキュメントを書かないことは「負債を生む」ということ #...
-[[ドキュメント作成の手法について(図解作成) #ドキュメント...
-[[技術文書の長音記号どうする？「コンピューター」と「コン...
-[[設計ドキュメント腐る問題、Git管理で運用してみた結果 | ...
-[[データフロー図：情報の流れを視覚化し、ビジネスを理解す...
-[[エンジニア歴20数年の私が、設計書を書く際に心がけている...
-[[サーバーサイド仕様書をGitHubで管理してよかったこと - d...
-[[「エンジニアのためのドキュメントライティング」Docs for...
--[[【書籍】エンジニアのためのドキュメントライティング>ht...
-[[【NW構成図】は一周まわってエクセルで書けば良いのでは？...
-[[【書籍】ユーザーの問題解決とプロダクトの成功を導く エ...
-[[読みやすいドキュメントを書くために今日からできる7つの...
--1. 書くまえに、ドキュメントの目的を明確に定義する
--2. 書くまえに、筋道が立っているかを強く意識する
--3. 書くときに、読み手視点を強く意識する
--4. 書いたあとに、自身で推敲する
--5. ドキュメントの冒頭に要点をまとめる
--6. 一文一義・一文50文字以内で書く
--7. 表や図を用いる
-[[ユーザーなのか、ユーザなのか>https://zenn.dev/iwamasa/...
-[[技術文書の書き方 · GitHub>https://gist.github.com...
-[[わかりやすいシステム構成図の書き方 - Qiita>https://qii...
-[[データベースのテーブル定義の仕様書を自動生成しよう | C...
-[[最近、意味のない「にぎやかし図解」がやたらと多い気がす...
-[[開米のロジック図解入門・実践講座 – わかりやすく...
-[[Excel方眼紙がダメな２つの理由>http://watanabek.cocolog...
--まとめると、「Excel方眼紙」がダメな根源的な理由は２つあ...
--そういうわけで、この問題への対応状況には次の３段階があ...
---＜レベル０＞汎用ツールで仕様書を書いて、いちいちプログ...
---＜レベル１＞汎用ツールで仕様書を書いて、プログラミング...
---＜レベル２＞専用ツールで仕様書を書いて、プログラミング...
--参考記事：[[美文書作りには「方眼紙」シートを使う>http:/...
-[[ネットワーク図の書き方>http://d.hatena.ne.jp/elwoodblu...
-[[情報の構造化、してますか？>http://bizmakoto.jp/bizid/a...
-[[報告書の書き方>http://el.jibun.atmarkit.co.jp/yokoyama...
目標は何だったか
その目標は達成されたか
達成されたのは何が原因か
達成できなかったのは何が原因か
問題があった場合、解決のために自分はどんな努力をしたか
解決できなかった問題は、どうすれば解決できるか
そのためには何をしてほしいか
-仕様書の記述要領を決めるときに注意すべき一般的な項目
--大勢で仕様書を書くとき、平仄を合わせることが必要になり...
--スペースの表現方法。△を使うか、クォートで囲うか。
--改ページしたときにヘッダを再度表示するか。表で改ページ...
--注のつけ方。章ごとに注の本体を書くのか、ページごとに書...
--章立て、項目立ての項番体系。単項目になったときに番号を...
--既存の仕様書を修正で項番を削除するとき、詰めるのか、欠...
--ファイル名のつけ方のルール
--修正履歴の書き方。修正の理由も書くか。いつからバージョ...
--図表の番号、キャプションのつけかた
--Wordの場合、見出しにどんなスタイルをつけるか
--テンプレート(.dot)を使うか
--英数字は全角か、半角か
-[[読みやすい文章の極意は「修飾語」にあり>http://jibun.at...
-[[MSが長音付けルール変更、「ドライバ」を「ドライバー」に...
-[[発注者が理解しやすいシナリオの記述方法>http://www.nikk...
--システム化業務説明書とは，ある「システム化業務」の中で...
--基本，代替，例外の3つのシナリオを記述すること
--システム化業務のシナリオを利用者とシステムに分けて記述...
-[[ユーザと意思疎通が取れない外部設計書は危ない>http://it...
-[[議事録を書くときに意識すべきこと>http://d.hatena.ne.jp...
-[[議事録のプロ>http://itpro.nikkeibp.co.jp/article/COLUM...
--議事録には決まったことだけ書く
-[[どんな作業のマニュアルも３時間あれば作れる>http://d.ha...
--個人的には以下のようなマニュアル観は間違っていると思う。
---不完全なマニュアルを配られても困る
---マニュアルに書いてある通りにやって問題が起きるぐらいな...
---書いてある通りにやって問題が起きても作業者の責任ではな...
---マニュアルとは「書いてある通りに作業するためのもの」な...
---マニュアルがあると、それに頼り切って頭を使わなくなるの...
--どこが間違っているかというと、こう考える組織では永遠に...
-[[計画書をコピペしてはいけない>http://itpro.nikkeibp.co....
--「参考にする」ということと「コピペ」するということは違う
--ここはコピーしても大丈夫だろうと思っても，必ず一度自分...
-[[文章チェックを省略してはいけない>http://itpro.nikkeibp...
--「○○だけで（も）動く」と「○○でだけ動く」の違い
-[[仕様書の意義:http://dain.cocolog-nifty.com/myblog/2006...
--仕様書について人々が犯す最大の過ちは、公式のレビュー会...
*関連サイト [#n2961b30]
-[[はじめに | IT英語スタイルガイド>https://styleguide.pro...
-[[ドキュメント作成に役立つ「日本語スタイルガイド」の紹介...
-[[ラプラス取説研究所:http://laplace-lab.org/]]
*ツール [#e1f0a203]
→ドキュメント作成ツール ＜Draw.ioもこちら
*Help File [#c2427639]
-[[Sandcastle Help File Builder:http://www.codeproject.co...
-[[HTMLHelp:http://msdn.microsoft.com/library/default.asp...
ページ名:
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
