[フレーム]
はてなブックマークアプリ

サクサク読めて、
アプリ限定の機能も多数!

アプリで開く

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

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

エントリーの編集

loading...

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

タイトルガイドライン

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

タイトル、本文などの情報を
再取得することができます
コメントを非表示にできます コメント表示の設定

ブックマークしました

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

Twitterで共有

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

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

ガイドラインをご確認の上、良識あるコメントにご協力ください

0 / 0
入力したタグを追加

現在プライベートモードです 設定を変更する

おすすめタグタグについて

よく使うタグ

技術文書の書き方

ガイドラインをご確認の上、良識あるコメントにご協力ください

0 / 0
入力したタグを追加

現在プライベートモードです 設定を変更する

おすすめタグタグについて

よく使うタグ

はてなブックマーク

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

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

ユーザー登録

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

記事へのコメント31

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

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

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

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

その他
CLSmooth
"Architectural Decision Records (ADR)"

その他
tmatsuu
すばらしい

その他
tune
Protobuffet知らなかったので嬉しい。

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

その他
kappaseijin
"ツール"

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

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

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

その他
nilab
技術文書の書き方 · GitHub

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

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

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

その他
conp
"independent "

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

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

2022年09月03日 リンク

その他
awawawann
とてもよい

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

その他
asa_ca3
Excelが出てこなくて安心した

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

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

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

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

その他
razokulover
mermaid便利

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

その他
tadyjp
よいね

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

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

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

2022年09月02日 リンク

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

2022年09月02日 リンク

その他
everybodyelse
これは良いやつ

その他

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

リンクを埋め込む

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

プレビュー
アプリのスクリーンショット
いまの話題をアプリでチェック!
  • バナー広告なし
  • ミュート機能あり
  • ダークモード搭載
アプリをダウンロード

関連記事

usersに達しました!

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

気持ちをシェアしよう

ツイートする

技術文書の書き方

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

ブックマークしたユーザー

  • y-teraoka2025年08月04日 y-teraoka
  • ikosin2025年02月07日 ikosin
  • RUMCMOOS2024年08月03日 RUMCMOOS
  • txmx52024年07月14日 txmx5
  • CLSmooth2024年07月03日 CLSmooth
  • umiyosh2024年05月08日 umiyosh
  • tasshi8202024年04月26日 tasshi820
  • lulichn2024年01月11日 lulichn
  • mopin2024年01月07日 mopin
  • technicolor52024年01月06日 technicolor5
  • akiyantan2024年01月06日 akiyantan
  • wate_wate2024年01月06日 wate_wate
  • miguchi2024年01月06日 miguchi
  • tmysz2024年01月06日 tmysz
  • nariatsu2024年01月06日 nariatsu
  • tmd2024年01月06日 tmd
  • t2wave2024年01月06日 t2wave
  • hrmkcode2024年01月06日 hrmkcode
すべてのユーザーの
詳細を表示します

ブックマークしたすべてのユーザー

同じサイトの新着

同じサイトの新着をもっと読む

いま人気の記事

いま人気の記事をもっと読む

いま人気の記事 - テクノロジー

いま人気の記事 - テクノロジーをもっと読む

新着記事 - テクノロジー

新着記事 - テクノロジーをもっと読む

同時期にブックマークされた記事

いま人気の記事 - 企業メディア

企業メディアをもっと読む

はてなブックマーク

公式Twitter

はてなのサービス

Copyright © 2005-2025 Hatena. All Rights Reserved.
設定を変更しましたx

AltStyle によって変換されたページ (->オリジナル) /