How to document software architecture? | TSH.ioDigital Product Design Make your product the first choice for users with designers who built dozens of them. Agile Development Teams Work with product experts with the know-how tested in 7+ industries.
ARCHITECTURE.mdというものを書いてみた - maru source
こんにちは丸山@h13i32maruです。システム全体を簡単な図とテキストでまとめる「ARCHITECTURE.md」というものを最近知りました。これは良さそうと思い、JasperのARCHITECTURE.mdを書いてみました。 jasperapp/jasper/ARCHITECTURE.md ARCHITECTURE.md自体の目的は「プロジェクトへの新規参加者が全体像の把握を効率的に行えるようにする」という感じです。書き方の指針や注意点などは考案者による記事を見てもらうのがよさそうです。また良いサンプルとしてrust-analyzerというOSSのARCHITECTURE.mdが紹介されています。 https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html https://github.com/rust-analyzer/ru
アーキテクチャドキュメントに必要なこと [arch]
最近本腰を入れて大掛かりなアーキテクチャ設計をしようとしているが，ドキュメントを書く際にいつも帰ってくるのがこのエントリー． Hitchhiker's Guide to Software Architecture and Everything Else - by Michael Stal: What should be in an Architecture Document? とても素晴らしい内容なので，以下に意訳しておきます．ぜひ原文も合わせて読んでみて下さい． - ドメインモデル (もしあれば)，使用されているパターン，ガイドラインなどに特化したドキュメントを合わせて紹介すること．アーキテクチャドキュメントは，それらのガイドラインと整合性を保つこと． - 1つのドキュメントは50ページを超えないこと．肥大化したドキュメントは誰にも読まれない (少なくともその全ての内容は)． - 当たり
ソフトウェアアーキテクチャ その11 - 健全なドキュメントを書く7つのルール [arch]
今回は少し趣向を変えて，ドキュメントの書き方について取り上げたいと思う． "Documenting Software Architectures" に記述されている，「健全なドキュメントを書く7つのルール (Seven Rules for Sound Documenation)」を紹介する． ところでこのエントリーを書きながら，e-mail や Blog を書く時にも当てはまることがいくつもあると思った． Reference: Documenting Software Architectures: Views and Beyond, by Clements, et al. Addison-Wesley 2003 --> Page 24 - 30 タイトル通り，アーキテクチャのドキュメント記述方法に関する本で，SEI の Product Line Systems Program の成果物の1
![ソフトウェアアーキテクチャ その11 - 健全なドキュメントを書く7つのルール [arch]](https://cdn-ak-scissors.b.st-hatena.com/image/square/bbb87ad2867874cfebe8d2583f56b1fba13d817a/height=288;version=1;width=512/https%3A%2F%2Flh3.googleusercontent.com%2Fblogger_img_proxy%2FAHs97-mBZDC1ID2qQqOozyzQRvnxVlf61GHP7zV97eidnZVGkSovFvzijkhKVAi2YdIxZqG_BAX2UUTETui32nZSg7b1zmuK1gohdNHrL_t1g5wsxXcuHvrxm7YSI2XuNRpH3GPL%3Dw1200-h630-p-k-no-nu)
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
