InfoQ ホームページ ドキュメンテーション に関するすべてのコンテンツ
アーティクル
RSSフィード-
/articles/organizational-resilience-documentation/ja/smallimage/building-organizational-resilience-through-documentation-and-InnerSource-small-1702890930736.jpg)
より多く書き、より少なく話す：ドキュメンテーションとインナーソースで組織のレジリエンスを高める
思い浮かべてほしい。あなたは会社に入ったばかりで、社内の共有インフラプラットフォームについて学ぼうとしている。社内のドキュメントサイトを検索しても答えが見つからないので、Slackのような社内メッセージングツールに助けを求めようとしている。 Slackを通じて、別のエンジニアから質問の答えを見つけたが、その情報がどこにも書かれていないことに気づく。これは理想的な答えの見つけ方ではないが、よくあることだ。質問に対する回答は得られるが、次に同じ質問をする人はどうなるのだろうか？この問題は、ドキュメント化、ダイアグラム、アーキテクチャの決定、その他、システムがなぜそのように機能するのかを理解するための一般的な方法である。
-
/articles/continuous-documentation/ja/smallimage/SWIMM-s-1622628522688.jpg)
継続的ドキュメンテーション - コード知識共有への新たなアプローチ
ドキュメントは開発の重要な部分です。しかし、コードが変更されれば、ドキュメントはすぐに陳腐化してしまいます。継続的ドキュメンテーションでは、継続的に検証する、最も必要な時に作成する、コードに結合する、という3つの原則を重視します。
-
/articles/why-architectural-diagrams/ja/smallimage/why-architectural-diagrams-s-1547639074677.jpeg)
なぜアーキテクチャ図を必要とする���か？
ソフトウェアアーキテクチャ図は、うまく作ると、開発チーム内および外部ステークホルダーとのコミュニケーションを大幅に改善させることができる。それには、対象読者を理解することと、含めるべきものを慎重に自制することが必要だ。ひどい図がたくさんあったというだけで、図なんて必要ない、役に立たないと考えないようにしよう。
-
/articles/subbu-allamaraju-rest/ja/smallimage/image_bank_account.jpg)
RESTfulなアプリケーションを記述する
新しい記事では、Subbu AllamarajuがRESTfulなAPIを記述する方法を説明します。そして、WADLやWSDLといった範囲外の記述フォーマットの代わりにハイパーメディアの利用にフォーカスします。
-
/articles/architecture-as-language-a-story/ja/smallimage/markusvolter.jpg)
言語としてのアーキテクチャ： ストーリー
アーキテクチャは一般に、Word文書に主として見られるような極めて実体のない、ソフトウェアシステムの概念的な側面であるか、または完全に技術によって駆動されるものかのいずれかです。そのどちらも間違っています。では、どう対処すればよいでしょうか? この記事ではアイデアを説明します、そしてアプローチのキーポイントを要約します。
-
/articles/EJB-Glossary/ja/smallimage/ejbsmall.jpg)
EJB 3 用語集
これは、EJB 3 で採用された新しい用語とコンセプトの基本用語集である。この用語集では、（IoC）、例外による構成、POJO、POJI、依存挿入、埋め込み可能なオブジェクト、インターセプターといった専門用語について解説している。