タグ: #technical-writing
GPU・LLM・MLOps・Kubernetes、そしてマインドセット · 13 件
エンジニアの書く力 — 設計文書・障害報告・レビューコメントの仕事
エンジニアに文章力が大事だという話はよく聞きますが、なぜ大事なのかはたいてい昇進の話で終わります。この記事は順序を変えて見ます。文章はまず自分の思考を検証する装置であり、組織の中で反論できる面を作る道具であり、その結果として評価に影響します。設計文書で最も重要なのがなぜ捨てた案なのか、障害報告で事実と解釈を分けることがなぜ政治ではなく技術なのか、レビューコメントに等級を付けるとなぜ衝突が減るのかを扱います。高いまま残る技術シリーズの第5
2026-08-15 · 13 分で読めます #career#skills#technical-writing#design-doc#postmortemDiátaxisを四つのフォルダと誤解する理由 — ひとつの文書に二つのモードを混ぜるとなぜ崩れるのか
Diátaxisは文書をチュートリアル・ハウツー・リファレンス・説明の四種類に分けます。ところがチームのほとんどはフォルダを四つ作ったところで適用を終え、肝心の問題はそのまま残ります。本当の失敗は分類ではなく、ひとつの文書のなかで四つのモードを混ぜるときに起きるからです。混ざるとなぜ崩れるのかを、フレームワークが根拠にする二つの軸から辿り直し、段落単位で判定する羅針盤と、今週すぐ回せる作業ループまで整理しました。
2026-08-09 · 16 分で読めます #documentation#diataxis#technical-writing#developer-experience#information-architecture文章で働く開発者 — デザインドック、ADR、そして説得するテクニカルライティング
文章力がシニアエンジニアのレバレッジである理由から、デザインドックとADRの実践テンプレート、レビューを通過するドキュメントの技術、悪い文章のビフォー/アフター、AIを書くことに活用する方法と限界まで。コードより先にドキュメントが評価される時代のテクニカルライティングガイドです。
2026-06-12 · 39 分で読めます #technical-writing#design-docs#adr#documentation#careerAI 時代の開発者英語: AGENTS.md・システムプロンプト・RFC — エージェントが読む英語を書く技術
2026年、開発者が書く英語のうち最もレバレッジが高いのは、人間ではなくエージェントが読む英語です。AGENTS.md / CLAUDE.md のコンテキストファイル、プロダクションエージェントのシステムプロンプト、人間とエージェントの両方が読む RFC / デザインドック、エージェントが行動できる Issue 説明まで — 「エージェントは literal に読む」という原則を軸に、弱い英語と強い英語の before / after
2026-05-14 · 39 分で読めます #developer-english#ai-writing#agents-md#claude-md#system-prompt開発者のためのテクニカルライティングガイド：RFC、ADR、技術ブログ、APIドキュメント作成法
開発者ライティングの全て！RFC（Request for Comments）、ADR（Architecture Decision Records）、APIドキュメント（OpenAPI）、README、CHANGELOG、技術ブログの書き方、ダイアグラム（Mermaid/PlantUML）、ドキュメンテーション文化まで。
2026-03-24 · 30 分で読めます #technical-writing#documentation#rfc#adr#api-docs開発者のための技術文書作成完全ガイド：READMEからADRまで
READMEファイルからAPI文書、アーキテクチャ決定記録（ADR）まで、技術文書作成の完全ガイド。Diátaxisフレームワークと最新の文書化ツールについて学びます。
2026-03-16 · 12 分で読めます #documentation#technical-writing#soft-skills#developer#api-docs英語レポート作成 完全ガイド：エグゼクティブサマリーからデータドリブンな報告まで
エンジニアのための英語レポート作成実践ガイド。エグゼクティブサマリー、技術レポート、障害レポート、週次レポートなど、タイプ別の書き方と主要表現を整理します。
2026-03-13 · 8 分で読めます #english#report-writing#technical-writing#communication#business-writing技術報告書作成ガイド：構造設計からデータ可視化、自動化まで
ITエンジニアのための技術報告書作成完全ガイド。報告書タイプ別の構造設計、ピラミッド原則、MECEフレームワーク、データ可視化技法、マークダウンテンプレート、自動化ツールまで実践ノウハウをまとめます。
2026-03-13 · 26 分で読めます #culture#report-writing#technical-writing#documentation#visualization技術文書英語ライティングガイド: RFC·ADR·Design Doc·Tech Specテンプレートと実践表現
ソフトウェアエンジニアのための技術文書英語ライティングガイドです。RFC、ADR、Design Doc、Tech Specの構造とテンプレートを比較し、各セクション別の主要英語表現（Problem Statement、Proposed Solution、Alternatives Considered、Trade-offs、Success Metrics）とレビューフィードバック表現、非ネイティブスピーカーの典型的なミスまで実践的にまとめ
2026-03-12 · 29 分で読めます #english#technical-writing#rfc#adr#design-doc英語技術文書作成完全ガイド：RFC・ADR・Design Docパターンと実践表現
RFC・ADR・Design Docパターンと実践表現を網羅した英語技術文書作成の完全ガイド。
2026-03-10 · 27 分で読めます #english#technical-writing#rfc#adr#design-doc英語インシデントコミュニケーション完全ガイド：障害報告からポストモーテム作成まで
ITエンジニアのための英語インシデントコミュニケーションガイド。障害発生時の初期報告、エスカレーション、ステータスページ更新、ポストモーテム作成まで実践で使える英語表現とテンプレート。
2026-03-08 · 40 分で読めます #english#incident-communication#postmortem#sre#technical-writing英語テクニカルライティング実践ガイド：RFC、ADR、Design Docの書き方とテンプレート
エンジニアのための英語技術文書作成法。RFC・ADR・Design Docの構造と目的、効果的な英語表現、実践テンプレートとレビュープロセス、グローバルチーム協業コミュニケーション戦略まで。
2026-03-06 · 37 分で読めます #english#technical-writing#rfc#adr#design-docTechnical Writing英語ガイド — 開発者のための技術文書作成法
README、APIドキュメント、RFCの書き方から、明確な文章構造、開発者がよくする英語のミスまで、Technical Writingの核心をまとめます。
2026-03-03 · 9 分で読めます #english#technical-writing#documentation#2026-03