気に入った記事をブックマーク

気に入った記事を保存できます
保存した記事の一覧は、はてなブックマークで確認・編集ができます
記事を読んだ感想やメモを書き残せます
非公開でブックマークすることもできます

技術文書の書き方

テクノロジーカテゴリーの変更を依頼記事元:

gist.github.com/ymmt2005

適切な情報に変更

エントリーの編集

エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。

このページのオーナーなので以下のアクションを実行できます

タイトル、本文などの情報を
再取得することができます

コメントを非表示にできますコメント表示の設定

ブックマークしました

ここにツイート内容が記載されますhttps://b.hatena.ne.jp/URLはspanで囲んでください

Twitterで共有

次回からTwitterへ自動リダイレクト

ONにすると、次回以降このダイアログを飛ばしてTwitterに遷移します

1106usersがブックマークコメント

コメントするにはログインが必要ですブックマークを追加

ブックマークを追加

よく使うタグ

技術文書の書き方

1106 users

gist.github.com/ymmt2005

よく使うタグ

はてなブックマークで
関心をシェアしよう

みんなの興味と感想が集まることで
新しい発見や、深堀りがもっと楽しく

ユーザー登録

アカウントをお持ちの方はログインページへ

記事へのコメント31件

注目コメント
新着コメント

syu-m-5151ドキュメンテーションはテストと同じくソフトウェアエンジニアリングという領域の基礎をなすものだと確信しているのですがこのドキュメンテーションに関する文章は圧倒的に良すぎますね...

2022/09/02リンク

その他

dh16tmdとかで書いておくとコードと同じように管理できるから強い。図の管理は課題だったがvscode+draw.io integrationが良すぎて解決した。

2022/09/02リンク

その他

Tomosugi「技術文書」よりもっとしっくりくる呼び名が欲しいところ……technical documentのtechnical はcreativeやliteratureと対をなすものだから「実務」ってことだからね

2022/09/03リンク

その他

programmablekinokoいいね。HW,特にチップのデータシートとかも参考になる。

2022/09/02リンク

その他

CLSmooth“Architectural Decision Records (ADR)”

2024/07/03リンク

その他

tmatsuuすばらしい

2022/09/04リンク

その他

tuneProtobuffet知らなかったので嬉しい。

2022/09/04リンク

その他

roshiGitHub Flavored Markdownというかプレビュー機能にVSCodeが追従してくれれば書く方も見る方も1アプリで済んで楽なんだけどなー。

2022/09/03リンク

その他

kappaseijin“ツール”

2022/09/03リンク

その他

nabinno私はPlantUML派。シークエンス図、アクティビティ図、ユースケース図、クラス図に加え、コンポーネント図まで扱えるからMermaidとdraw.ioでやりたいことは大方PlatUMLで片付く。

2022/09/03リンク

その他

aox全部7775調で書けば歌えるのでは

2022/09/03リンク

その他

asuka0801Design DocsとADRの使い分けいつも迷う。大体Design Docsに全部ババーッと書いてしまう事が多いなぁ。

2022/09/03リンク

その他

nilab技術文書の書き方 · GitHub

2022/09/03リンク

その他

mizdra網羅性高めるためには自動生成しましょう、なるほど

文章

2022/09/03リンク

その他

Nyoho「mdBook: Rust 製 static site generator。高速でビルドできて見栄えが良いです。」

2022/09/03リンク

その他

kazokmrちょっとした図を書くときにmiro使うんだけど、文書化には適さないなと思ってたので、ここに書かれているツールを試してみようかな

2022/09/03リンク

その他

conp“independent ”

2022/09/03リンク

その他

yasu-osuこの文章自体が読みやすくて、とても参考になりました。おすすめです。

2022/09/03リンク

その他

2022/09/03リンク

その他

awawawannとてもよい

2022/09/03リンク

その他

media56a技術怪文書の書き方に見えちゃった

2022/09/03リンク

その他

asa_ca3Excelが出てこなくて安心した

2022/09/03リンク

その他

BaramakiFPSドキュメント管理の参考として

ツール

2022/09/03リンク

その他

dorapon2000“外部仕様書の類は、網羅していることと正確であることが大事。自動生成を第一の選択肢に。”

2022/09/03リンク

その他

inductor良くまとまってるなー便利だ。

2022/09/02リンク

その他

peketamin新しくなんかやるかと思って2年前に友達とやったプロジェクトを覗いたら、何を念頭に置いてたかもすっかり忘れてて焦ったけど、残しておいたドキュメントを読むことで思い出せた。WhyとかIF設計とか残すの大事。

2022/09/02リンク

その他

razokulovermermaid便利

2022/09/02リンク

その他

atsushieno最近流行りのAreWeYetは入ってなかった。

2022/09/02リンク

その他

tadyjpよいね

2022/09/02リンク

その他

yarumato“新規にソフトウェアを書き起こすときには、必ず設計文書を書く。設計文書には、最低限「解決したい課題とその背景」「実装することになる予定の機能」「実装方針」を書きます。”

2022/09/02リンク

その他

IGA-OSそろそろワークフローもしてdrow.ioを組込んでみるかなぁ

2022/09/02リンク

その他

programmablekinokoいいね。HW,特にチップのデータシートとかも参考になる。

2022/09/02リンク

その他

dh16tmdとかで書いておくとコードと同じように管理できるから強い。図の管理は課題だったがvscode+draw.io integrationが良すぎて解決した。

2022/09/02リンク

その他

everybodyelseこれは良いやつ

2022/09/02リンク

その他

コメントするにはログインが必要ですログインしてコメント

注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

リンクを埋め込む

以下のコードをコピーしてサイトに埋め込むことができます

プレビュー

はてなブックマークボタンを作成して埋め込むこともできます

規約違反を報告

いまの話題をアプリでチェック！

バナー広告なし
ミュート機能あり
ダークモード搭載

アプリをダウンロード

usersに達しました！

さんが1番目にブックマークした記事「技術文書の書き方」が注目されています。

気持ちをシェアしよう

ツイートする

技術文書の書き方

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