ドキュメントを書く技術 - blog
READMEを始め、ソフトウェアのドキュメント全般を書く技術というものをもっと洗練させていきたい。要件定義書のようなものだけでなく、開発方針や設計方針、API定義などなど。 これらのドキュメントをしっかりと整備するだけで、レビューの質も上がり新しい人が入ったときもスムーズに意識のズレなく開発ができる。はずだが、なかなかドキュメントの上手い書き方や管理の仕方というものは、コーディングのそれとは違い議論が活発ではない。 最近試してみたこと そういったドキュメントの中でも、"開発方針"や"設計思想"をどう残していくかということを考えている。それらを残しておくことで、コーディングのときも立ち戻る場所ができ、大きく道を踏み外さなくなる。 例えば、レイヤードアーキテクチャのようなものの"境界"をドキュメントにしていく。MVCでもクリーンアーキテクチャでも何でも良いけど、それらのアーキテクチャではそれぞ
新人エンジニアに読んでもらいたい「7つの本 + α」 - なぎにゃぎのにょきにょきにっき
どーも。 なぎにゃぎです。 毎年4月になると多くの新人ＩＴエンジニアの方が職場に配属されますね。 僕は新人時代にしっかりとした研修を受けられず、苦労した記憶があります。 自分で色々と技術書などを買い漁って勉強しましたけど、その中でも特に若いうちに読んでおきたい書籍を紹介したいと思います。 追記 おすすめしたい本が増えてきたので随時更新していきたいと思います。 コーディング リーダブルコード プリンシプル オブ プログラミング3年目までに身につけたい一生役立つ101の原理原則 リファクタリング テクノロジー Webを支える技術 絵で見てわかる Oracleの仕組み アルゴリズム図鑑 絵で見てわかる26のアルゴリズム その他 入門 考える技術・書く技術 なぜ、あなたの仕事は終わらないのか 「納品」をなくせばうまくいく まとめ コーディング リーダブルコード リーダブルコード ―より良いコードを
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
