エンジニアが一生困らない ドキュメント作成の基本
- 著者:
- 仲田 尚央
- 出版社:
- 不明
- 出版日:
- 不明
- ISBN:
- 9784802614849
中級者向け
ドキュメント作成テクニカルライティングエンジニア向け日本語ライティング技術文書効率的な執筆ChatGPT読み手中心設計ドキュメント設計プロフェッショナルなコミュニケーション
なぜ注目されているか
総合
400位
3 件の言及言及 Qiita 記事 (3 件)
この本に興味がある方におすすめ
この本に関連
関連記事
技術書と公式ドキュメントの使い分け - それぞれの強みを活かす
技術書と公式ドキュメントの役割の違いを明確にし、学習段階に応じた最適な使い分け方を紹介します。
学習法公式ドキュメント
インフラ・クラウド本ガイド - AWS や Docker を本で学ぶ
クラウドインフラ、コンテナ、IaC を学べる技術書の選び方と学習順序を紹介。インフラ本の賞味期限問題と公式ドキュメントとの使い分けも解説します。
インフラ選書ガイド
なぜ上級者ほど入門書を読み返すのか
経験豊富なエンジニアが入門書を読み返す理由を解説します。初心者のときには見えなかった設計思想や暗黙の前提が、経験を積んだ目で読むと浮かび上がります。
読書術技術書
関連用語
API ドキュメントとは - 仕様・エンドポイント・入出力形式を記述し開発者の統合を支援する文書
API の仕様、エンドポイント、リクエスト/レスポンス形式を記述し、開発者の統合を支援するドキュメント
テクニカルライティング
技術的な情報を正確かつ分かりやすく伝えるための文書作成スキル
RAG
外部知識を検索して LLM の回答精度を向上させるアーキテクチャ
FastAPI
Python 製の高速な Web API フレームワーク。型ヒントを活かした効率的な開発が特徴
YAML
人間が読みやすいデータシリアライゼーション形式で、設定ファイルや CI/CD の定義に広く使われる
カオスエンジニアリング
本番環境で意図的に障害を注入し、システムの耐障害性を検証する実践手法