ドキュメントはなぜ書くべきなのか - inductor's blog
はじめに 最近、仕事・プライベート問わず技術的な内容に関して人に教える機会をいただくようになりました。 僕は前のチームの影響で文章を書くことの重要性を意識するようになりましたが、最近はどうしても面倒で後回しにしがちなドキュメントをどうやったら書けるようになるかということについても考えています。 なぜドキュメントは大切なのか ドキュメントの重要性は、個人的な感覚ではテストコードに近いと思っています。 特にプロジェクト初期や設計の段階では、「なぜその技術を選んだのか」や、「なぜこの方針にしたのか」といったことを議論したり、複数の選択肢から技術を選定するためにさまざまな比較検討を行います。 このとき、決めたことはコードとして残りますが、「検討したが採用しなかったアイデア」についてはコード内ではなかったものにされ、見えなくなってしまいます。正確に言うと、コードとしては不要なものはいらないのでそれは
Basic writing and formatting syntax - GitHub Docs
Headings To create a heading, add one to six # symbols before your heading text. The number of # you use will determine the hierarchy level and typeface size of the heading. # A first-level heading ## A second-level heading ### A third-level heading When you use two or more headings, GitHub automatically generates a table of contents that you can access by clicking within the file header. Each hea
【中級】今から取り組むUML入門 第2回 UML図の読み方と書き方
UMLには(1)システムの静的な側面を示す図，(2)システムの動きを説明する図，(3)システムの構成などを説明する図があり，システムをさまざまな視点から分析し，その結果を図示することができる。今回は，クラス図，ユース・ケース図，ステート・チャート図などのUMLの全図の表記法を説明する。説明するのは図記号や矢印の意味などの表記上のルールで，難しい理屈は無い。限られたページ数で細かい表記ルールまでは説明できないが，簡単な図を読んだり書いたりするには今回説明したことだけで十分である。 システム設計書やプログラム設計書の表記法として有効なUML（Unified Modeling Language）＊を初心者向けに解説するセミナーの第2回である。前回は，UMLの基盤であるオブジェクト指向＊の考え方と，それがUMLの9種類の図で表記できることを説明した。今回は，それぞれの図の役割と基本的な書き方を説明
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
