howto-tech-docs.md技術文書の書き方 このメモは、私(@ymmt2005)が長年にわたってソフトウェアプロダクト開発に関わってきて2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。

チェーホフの銃(チェーホフのじゅう、英語: Chekhov's gun)とは、小説や劇作におけるテクニック・ルールの1つ。 ストーリーの早い段階で物語に導入された要素について、後段になってからその意味なり重要性を明らかにする文学の技法。この概念は、ロシアの劇作家アントン・チェーホフに由来している。チェーホフはこの概念を様々な形に展開して、手紙の中で言及していた。 チェーホフの銃は、伏線の手法のひとつと解釈されるが、この概念は「ストーリーには無用の要素を盛り込んではいけない」という意味であるとも解釈できる[注 1]。チェーホフの銃のルールを守らない作品は、プロットの穴を論じる際に批評家に引用されることになりかねない。 チェーホフの銃という表現は、ストーリーに持ち込まれたものは、すべて後段の展開の中で使わなければならず、そうならないものはそもそも取り上げてはならないのだ、と論じた、アントン・チ
1リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く