良いドキュメントを書きたくなる本を読んだらドキュメンタリアンになりたくなった - じゃあ、おうちで学べる
ドキュメンタリアンとは、役職に関係なく、ソフトウェア業界でドキュメントとコミュニケーションに関心を持つ人のことです。 www.writethedocs.org はじめに これは主に『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。私はSreakeにてSREという役職についています。SREはサービス概要、アーキテクチャの解説や図、各種構成図、各種手順書、ポストモーテム、ポリシー、SLA(SLO) … その他の様々な場面でドキュメントを書く必要があります。しかし、ドキュメントは価値が見えにくく時間と労力がかかり品質担保の面で重要度がとても高いのにその場での価値が見えにくいので浸透しにくいです。そのため、エンジニアとしてモチベーションが保ちづらいです。2021年 State of DevOps 2021 にもドキュメントに関する言及があり今後、
ツールを使ったドキュメント作成技法（後編）（1/3） - ＠IT
特集：ツールを使ったドキュメント作成技法（後編） マイクロソフトも実施しているドキュメント作成技法 アバナード株式会社 市川 龍太（Microsoft MVP 2008 for XML） 2008/07/23 前編では、価値のあるドキュメントを作成するためのコツと、効率的にドキュメントを作成するためのツールとして「SandCastle」を解説した。後編では、そのほかのドキュメンテーション支援ツールとして「GhostDoc」と「patterns & practices Documentation Tools」について解説する。 ■柔軟なXMLドキュメント・コメントを生成する「GhostDoc」 GhostDocは、あらかじめ設定した任意の書式にのっとったXMLドキュメント・コメントを生成してくれるVisual Studioアドインであり、MSDNマガジンにて「すべての開発者がダウンロードする
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日本語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
セッション資料ダウンロード｜QCon Tokyo 2010 Conference｜QCon 東京 2010 カンファレンス
[Think IT] 第3回：リポジトリを使用したドキュメントの入力支援 (1/3)
